1. 接口描述
接口请求域名: redis.tencentcloudapi.com 。
本接口(ModifyBackupDownloadRestriction)用于修改备份文件下载的网络信息与地址。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyBackupDownloadRestriction。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
LimitType | 是 | String | 下载备份文件的网络限制类型: - NoLimit:不限制,腾讯云内外网均可以下载备份文件。 - LimitOnlyIntranet:仅腾讯云自动分配的内网地址可下载备份文件。 - Customize:指用户自定义的私有网络可下载备份文件。 示例值:NoLimit |
VpcComparisonSymbol | 否 | String | 该参数仅支持输入 In,表示自定义的LimitVpc可以下载备份文件。 示例值:In |
IpComparisonSymbol | 否 | String | 标识自定义的 LimitIp 地址是否可下载备份文件。 - In: 自定义的 IP 地址可以下载。 - NotIn: 自定义的 IP 不可以下载。 示例值:In |
LimitVpc.N | 否 | Array of BackupLimitVpcItem | 自定义的可下载备份文件的 VPC ID。当参数LimitType为*Customize *时,需配置该参数。 |
LimitIp.N | 否 | Array of String | 自定义的可下载备份文件的 VPC IP 地址。当参数LimitType为*Customize *时,需配置该参数。 示例值:["10.1.1.12", "10.1.1.13"] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改备份文件下载地址。
通过该接口修改当前地域用户自定义的备份文件下载网络与地址。
输入示例
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyBackupDownloadRestriction
<公共请求参数>
{
"LimitType": "Customize",
"VpcComparisonSymbol": "In",
"IpComparisonSymbol": "NotIn",
"LimitVpc": [
{
"VpcList": [
"vpc-5og4fwm9",
"vpc-03dsikyx"
],
"Region": "ap-guangzho"
}
],
"LimitIp": [
"10.1.0.13"
]
}
输出示例
{
"Response": {
"RequestId": "489f7bc7-e0e0-4e6f-a5c4-97c5fcf7ea8b"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.SystemError | 内部系统错误,和业务无关。 |
InternalError.DbOperationFailed | 统一的 DB 操作错误,可以是 update insert select..。 |
InvalidParameter.InvalidParameter | 业务参数错误。 |
InvalidParameter.PermissionDenied | 接口没有cam权限。 |
UnauthorizedOperation.NoCAMAuthed | 无cam 权限。 |