续费实例(包年包月)

最近更新时间:2017-04-12 19:42:25

1. 接口描述

本接口(RenewCdb)用于续费云数据库实例,仅用于付费模式为包年包月的实例(主实例和只读实例),按量计费实例不需要续费。
接口请求域名:cdb.api.qcloud.com

2. 输入参数

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

参数名称 必选 类型 描述
cdbInstanceId String 实例ID,格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例ID相同,可使用查询实例列表 接口获取,其值为输出参数中字段 uInstanceId 的值。
period Int 续费时长,单位:月,最小值1,最大值为36,请使用查询可创建规格接口获取可创建的实例时长,该接口返回字段timeSpan表示时长可选值

3. 输出参数

参数名称 类型 描述
code Int 公共错误码, 0表示成功,其他值表示失败。详见错误码页面的公共错误码
message String 模块错误信息描述,与接口相关。
codeDesc String 英文错误描述
dealIds Array 短订单ID,用于调用云API相关接口,如获取订单信息

其中, data 参数的构成如下:

参数名称 类型 描述
dealIds Array 短订单ID,用于调用云API相关接口,如获取订单信息
dealNames Array 长订单ID,用于反馈订单问题给腾讯云官方客服
cdbInstanceIds Array 实例ID列表,以长订单ID为键,实例ID为值

4. 错误码表

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

错误代码 英文提示 错误描述
100207 OperationConstraints.AccountBalanceNotEnough 帐户余额不足
9650 InvalidParameter 该实例不是可续费的包年包月实例
9572 InstanceNotExists 实例不存在
9301 InvalidParameter 交易参数错误
9006 InternalError 数据库内部错误

5. 示例

输入

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

输出

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "dealIds": [
        "458936"
    ],
    "data": {
        "dealNames": [
            "20161222110059"
        ],
        "dealIds": [
            "458936"
        ],
        "cdbInstanceIds": {
            "20161222110059": [
                "cdb-0pzitle8"
            ]
        }
    }
}