销毁实例(按量计费)

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

1. 接口描述

本接口(CloseCdbHour)用于销毁按量计费的实例,销毁后实例将变为隔离状态,可使用DescribeCdbInstances接口来查询隔离中的实例。
接口请求域名:cdb.api.qcloud.com

2. 输入参数

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

参数名称 是否必选 类型 描述
cdbInstanceIds.n String 一个或者多个实例ID,n表示从0开始的数组下标。实例ID,格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例ID相同,可使用查询实例列表 接口获取,其值为输出参数中字段 uInstanceId 的值。
instanceRole String 实例类型,默认为master,支持的值:master-主实例或灾备实例;ro-只读实例

3. 输出参数

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

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

参数名称 类型 描述
instanceRole String 实例类型,默认为master,支持的值:master-主实例或灾备实例;ro-只读实例
cdbInstanceIds Array 销毁实例结果列表

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

参数名称 类型 描述
code Int 执行结果,可能返回的值:0-成功;非0-失败
message String 错误描述,当 code 为非0时,该值有效
cdbInstanceId String 实例ID,格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例ID相同,可使用查询实例列表 接口获取,其值为输出参数中字段 uInstanceId 的值。

4. 错误码表

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

错误代码 英文提示 错误描述
9003 InvalidParameter 参数错误
9006 InternalError 数据库内部错误
9572 InstanceNotExists 实例不存在
9501 InternalError 下线实例失败
9648 InternalError.TranIdNotExist TranId不存在
9300 OperationDenied 订单系统错误

5. 示例

输入

https://cdb.api.qcloud.com/v2/index.php?Action=CloseCdbHour
&<公共请求参数>
&cdbInstanceIds.0=cdb-c1nl9rpv
&instanceRole=master

输出

{
    "code":"0",
    "message":"",
    "codeDesc":"Success",
    "data":{
        "cdbInstanceIds":[
            {
                "code":"0",
                "message":"",
                "cdbInstanceId":"cdb-c1nl9rpv"
            }
        ],
        "instanceRole":"master"
    }
}