1. 接口描述
接口请求域名: cdb.tencentcloudapi.com 。
该接口用户查询当前地域用户设置的默认备份下载来源限制。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeBackupDownloadRestriction。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-20。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
LimitType | String | NoLimit 不限制,内外网都可以下载; LimitOnlyIntranet 仅内网可下载; Customize 用户自定义vpc:ip可下载。 只有该值为 Customize 时, LimitVpc 和 LimitIp 才有意义。 示例值:LimitOnlyIntranet |
VpcComparisonSymbol | String | 该参数仅支持 In, 表示 LimitVpc 指定的vpc可以下载。 示例值:In |
IpComparisonSymbol | String | In: 指定的ip可以下载; NotIn: 指定的ip不可以下载。 示例值:NotIn |
LimitVpc | Array of BackupLimitVpcItem | 限制下载的vpc设置。 |
LimitIp | Array of String | 限制下载的ip设置。 示例值:["1.2.3.4","4.3.2.1"] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询备份下载来源限制
输入示例
POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackupDownloadRestriction
<公共请求参数>
{}
输出示例
{
"Response": {
"IpComparisonSymbol": "NotIn",
"LimitIp": [
"1.2.3.4",
"192.168.10.0/24"
],
"LimitType": "Customize",
"LimitVpc": [
{
"Region": "ap-guangzhou",
"VpcList": [
"vpc-aa3ximox",
"vpc-64elqxc9"
]
}
],
"RequestId": "b0439fbf-f835-4327-bed8-184d48ef43db",
"VpcComparisonSymbol": "In"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError.AuthError | 鉴权失败。 |
InternalError.DBError | 数据库异常。 |
InternalError.UnknownError | 未知错误。 |