设置自动续费

最近更新时间:2017-12-14 10:10:58

1. 接口描述

本接口(SetCdbAutoRenew)用于设置或取消实例的自动续费(包括主实例和只读实例)。
接口请求域名:cdb.api.qcloud.com

  1. 实例被标识为自动续费后,每次在实例到期时,会自动续费一个月。
  2. 在使用本接口前,请先确保用户账户余额充足。
  3. 按量计费的实例不需要设置为自动续费。

2. 输入参数

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

参数名称 必选 类型 描述
cdbInstanceId String 实例ID,格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例ID相同,可使用查询实例列表 接口获取,其值为输出参数中字段 uInstanceId 的值。
isAutoRenew String 是否自动续费,值包括:Y-设置为自动续费,N-设置为不自动续费

3. 输出参数

参数名称 类型 描述
code Int 公共错误码, 0表示成功,其他值表示失败。详见错误码页面的公共错误码
message String 模块错误信息描述,与接口相关。
codeDesc String 英文错误描述
data Array 数据

4. 错误码表

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

错误代码 英文提示 错误描述
9572 InstanceNotExists 实例不存在
9006 InternalError 数据库内部错误

5. 示例

输入

https://cdb.api.qcloud.com/v2/index.php?Action=SetCdbAutoRenew
&<公共请求参数>
&cdbInstanceId=cdb-c1nl9rpv
&isAutoRenew=Y

输出

{
    "code":"0",
    "message":"",
    "codeDesc":"Success",
    "data":[]
}