有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

接口请求域名: redis.tencentcloudapi.com 。

本接口(DescribeBackupDownloadRestriction)用于查询当前地域数据库备份文件的下载地址。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeBackupDownloadRestriction。
Version String 公共参数,本接口取值:2018-04-12。
Region String 公共参数,详见产品支持的 地域列表

3. 输出参数

参数名称 类型 描述
LimitType String 下载备份文件的网络限制类型:

- NoLimit:不限制,腾讯云内外网均可以下载备份文件。
- LimitOnlyIntranet:仅腾讯云自动分配的内网地址可下载备份文件。
- Customize:指用户自定义的私有网络可下载备份文件。
示例值:NoLimit
VpcComparisonSymbol String 该参数仅支持输入 In,表示自定义的LimitVpc可以下载备份文件。
示例值:In
IpComparisonSymbol String 标识自定义的 LimitIp 地址是否可下载备份文件。

- In: 自定义的 IP 地址可以下载。
- NotIn: 自定义的 IP 不可以下载。
示例值:In
LimitVpc Array of BackupLimitVpcItem 自定义的可下载备份文件的 VPC ID。当参数LimitType为*Customize *时,显示该参数。
LimitIp Array of String 自定义的可下载备份文件的 VPC IP 地址。当参数LimitType为*Customize *时,显示该参数。
示例值:["10.1.1.12", "10.1.1.13"]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询当前地域用户设置的备份文件的下载来源限制。

通过该接口查询当前地域用户设置的备份文件的下载来源限制。

输入示例

POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackupDownloadRestriction
<公共请求参数>

{}

输出示例

{
    "Response": {
        "IpComparisonSymbol": "NotIn",
        "LimitIp": [
            "10.1.0.13"
        ],
        "LimitType": "Customize",
        "LimitVpc": [
            {
                "Region": "ap-guangzhou",
                "VpcList": [
                    "vpc-5og4fwm9",
                    "vpc-03dsikyx"
                ]
            }
        ],
        "RequestId": "785b6c5f-999f-43ef-9906-14f4c24b8040",
        "VpcComparisonSymbol": "In"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.SystemError 内部系统错误,和业务无关。
InternalError.DbOperationFailed 统一的 DB 操作错误,可以是 update insert select..。
InternalError.InternalError 内部错误。
InvalidParameter.PermissionDenied 接口没有cam权限。
UnauthorizedOperation.NoCAMAuthed 无cam 权限。