设置自动续费

最近更新时间:2017-05-03 14:34:57

1. 接口描述

本接口(SetMongoDBAutoRenew)用于给实例设置自动续费。
接口请求域名:mongodb.api.qcloud.com

2. 输入参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见公共请求参数页面。其中,此接口的Action字段为SetMongoDBAutoRenew。

参数名称 是否必选 类型 描述
instanceIds.n String 一个或者多个实例ID,n表示从0开始的数组下标。 可通过 DescribeMongoDBInstances 接口返回值中的 instanceId 获取。
isAutoRenew Int 设置自动续费标识: 0 - 不设置自动续费,实例到期会通知;1 - 设置自动续费,到期会自动续费;2 - 到期不续费也不通知

3. 输出参数

参数名称 类型 描述
code Int 公共错误码,0表示成功,其他值表示失败。详见错误码页面的公共错误码
message String 错误信息描述, 成功时,该值为空
codeDesc String 业务侧错误码英文描述。成功时返回Success,错误时返回具体业务错误原因。

4. 错误码

以下错误码表列出了该接口的业务逻辑错误码。

错误代码 英文提示 错误描述
11050 InvalidParameter 业务参数错误
10716 NoInstanceIds 请求的实例ID数组为空
11056 InstanceNotExists 没有找到对应实例
11051 InstanceDeleted 实例到期已被回收

5. 示例

输入


https://mongodb.api.qcloud.com/v2/index.php?Action=SetMongoDBAutoRenew
&<公共请求参数>
&instanceIds.0=cmgo-6ozqe0uh
&isAutoRenew=1

输出

{
    "code": 0,
    "message": "",
    "codeDesc": "Success"
}