1. 接口描述
接口请求域名: cynosdb.tencentcloudapi.com 。
该接口用于修改用户当前地域的备份文件限制下载来源,可以设置内外网均可下载、仅内网可下载,或内网指定的vpc、ip可以下载。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyBackupDownloadRestriction。 |
Version | 是 | String | 公共参数,本接口取值:2019-01-07。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley 。 |
ClusterIds.N | 是 | Array of String | 集群ID 示例值:cynosdbmysql-bzxxrmtq |
LimitType | 是 | String | 下载限制类型,NoLimit-不限制,LimitOnlyIntranet-限制内网 ,Customize-自定义 示例值:MYSQL |
VpcComparisonSymbol | 否 | String | 该参数仅支持 In, 表示 LimitVpc 指定的vpc可以下载。默认为In 示例值:In |
IpComparisonSymbol | 否 | String | In: 指定的ip可以下载; NotIn: 指定的ip不可以下载 示例值:In |
LimitVpcs.N | 否 | Array of BackupLimitVpcItem | 限制下载的vpc设置 示例值:[{"Region": "ap-guangzhou", "VpcList": ["vpc-kas1"] } ] |
LimitIps.N | 否 | Array of String | 限制下载的ip设置 示例值:[127.0.0.1,127.0.0.2] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改集群下载限制
输入示例
POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyBackupDownloadRestriction
<公共请求参数>
{
"ClusterIds": [
"cynosdbmysql-2p3wjmzt"
],
"LimitType": "NoLimit",
"VpcComparisonSymbol": "",
"IpComparisonSymbol": "",
"LimitVpcs": [],
"LimitIps": []
}
输出示例
{
"Response": {
"RequestId": "1530aee8-5130-45ce-9f4e-dfb50a55e4d4"
}
}
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.DatabaseAccessError | 数据库访问失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
FailedOperation.FlowCreateError | 创建流程失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
FailedOperation.TradeCreateOrderError | 创建并支付订单失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
InternalError.DbOperationFailed | 查询数据库失败。 |
InternalError.UnknownError | 未知的内部错误。 |
InvalidParameterValue.ClusterNotFound | 未查询到集群。 |
InvalidParameterValue.InvalidParameterValueError | 参数值无效。 |
InvalidParameterValue.InvalidRegionIdError | 无效的地域。 |
OperationDenied.ClusterOpNotAllowedError | 由于操作禁止,当前集群不允许该操作。 |
ResourceNotFound.ClusterNotFoundError | 集群不存在。 |
ResourceUnavailable.InstanceLockFail | 锁定实例失败,暂时不可操作。 |
ResourceUnavailable.InstanceStatusAbnormal | 实例状态异常,暂时不可操作。 |
UnauthorizedOperation.PermissionDenied | CAM鉴权不通过。 |