灾备实例切换为主实例

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

1. 接口描述

本接口(SwitchCdbDrToMaster)用于云数据库灾备实例切换为主实例,公共参数的地域信息为灾备实例所在地域。
接口请求域名:cdb.api.qcloud.com

2. 输入参数

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

参数名称 是否必选 类型 描述
masterCdbInstanceId String 主实例ID,格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例ID相同,可使用查询实例列表 接口获取,其值为输出参数中字段 uInstanceId 的值。
drCdbInstanceId String 灾备实例ID,格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例ID相同,可使用查询实例列表 接口获取,其值为输出参数中字段 uInstanceId 的值。

3. 输出参数

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

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

参数名称 类型 描述
jobId Int 灾备实例切换为主实例任务ID。灾备实例切换为主实例是异步操作,提交成功后会返回一个任务ID,可使用查询任务列表 接口查询任务进度。

4. 错误码表

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

错误代码 英文提示 错误描述
9003 InvalidParameter 参数错误
9006 InternalError 数据库内部错误
9590 InternalFailure 任务数据库访问错误

5. 示例

输入

https://cdb.api.qcloud.com/v2/index.php?Action=SwitchCdbDrToMaster
&<公共请求参数>
&masterCdbInstanceId=cdb-jcti2cuw
&drCdbInstanceId=cdb-nam4hc1i

输出

{
    "code":"0",
    "message":"",
    "codeDesc":"Success",
    "data":{
        "jobId":"116"
    }
}