Query Instance GTID

Last updated: 2017-12-14 10:29:16

1. API Description

This API (GetCdbGtidInfo) is used to query the details of instance GTID.
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 GetCdbInitInfo.

Parameter Name Required Type Description
cdbInstanceId Yes String 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 Returned data

The data field is:

Parameter Name Type Description
GTID String GTID enabling status. Possible returned values: YES-Enabled, NO-Disabled

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

5. Example

Input

https://cdb.api.qcloud.com/v2/index.php?Action=GetCdbDataSyncTaskInfo
&
&cdbInstanceId=cdb-c1nl9rpv

Output

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "data": {
        "GTID": "YES"
    }
}