Help & DocumentationTencentDB for MySQLAPI DocumentsCDB API 2017Instance APIDB Instance to Master Instance

DB Instance to Master Instance

Last updated: 2017-12-14 10:27:09

PDF

Contents：

1. API Description

This API (SwitchCdbDrToMaster) is used to switch disaster recovery instances to master instances in the Cloud Database. The region in common parameters is the one where disaster recovery instances resides in.
Domain for API request: cdb.api.qcloud.com

2. Input Parameters

The following request parameter list only provides API request parameters. Common request parameters need to be added when the API is called. For more information, refer to Common Request Parameters. The Action field for this API is SwitchCdbDrToMaster.

Parameter Name Required Type Description
masterCdbInstanceId Yes String Master instance ID, such as: cdb-c1nl9rpv. It is identical to the instance ID displayed in the Cloud Database console page and can be obtained using API Query List of Instances. Its value equals to the uInstanceId field value in the output parameter.
drCdbInstanceId Yes String Disaster recovery Instance ID, such as: cdb-c1nl9rpv. It is identical to the instance ID displayed in the Cloud Database console page and can be obtained using API Query List of Instances. Its value equals to the uInstanceId field value in the output parameter.

3. Output Parameters

Parameter Name Type Description
code Int Common error code; 0: Succeeded; other values: Failed. For more information, please refer to Common Error Codes on the Error Code page.
message String Module error message description depending on API.
codeDesc String Error description
data Array Data
Parameter data is composed of the following parameters:
Parameter Name Type Description
jobId Int Task ID

4. Error Codes

The following error codes only include the business logic error codes for this API.

Error Code Error Message Error Description
9003 InvalidParameter Incorrect parameter
9006 InternalError Database internal error
9590 InternalFailure Task database access error

5. Example

Input

https://cdb.api.qcloud.com/v2/index.php?Action=SwitchCdbDrToMaster
&
&masterCdbInstanceId=cdb-jcti2cuw
&drCdbInstanceId=cdb-nam4hc1i

Output

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