1. 接口描述
接口请求域名: mongodb.tencentcloudapi.com 。
本接口(SetAutoRenew)用于设置包年包月云数据库实例的续费选项。
默认接口请求频率限制:20次/秒。
注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:mongodb.ap-shanghai-fsi.tencentcloudapi.com。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:SetAutoRenew |
Version | 是 | String | 公共参数,本接口取值:2018-04-08 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceIds.N | 是 | Array of String | 实例ID列表,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同 |
AutoRenewFlag | 是 | Integer | 续费选项,取值范围:0-手动续费,1-自动续费,2-确认不续费 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 设置包年包月实例的续费选项
输入示例
https://mongodb.tencentcloudapi.com/?Action=SetAutoRenew
&InstanceIds.0=cmgo-8l3r6yyt
&AutoRenewFlag=1
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "1d0d55f9-15ee-4f00-b460-7b645a62cc3a"
}
}
5. 开发者资源
API Explorer
该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameter | 参数错误 |
InvalidParameter.PermissionDenied | 当前子帐号无权执行该操作。 |
InvalidParameterValue.NotFoundInstance | 未找到实例。 |
InvalidParameterValue.PostPayRenewError | 按量计费实例不允许续费。 |