Query Database

Last updated: 2017-12-14 10:47:56

PDF

1. API Description

This API (QueryCdbDatabases) is used to query the database information of Cloud Database instance.
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 QueryCdbDatabases.

Parameter Name Required Type Description
cdbInstanceIds.n Yes String One or more instance IDs (n represents array subscript starting with 0). 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 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 Instance's database data

Parameter data is composed of the following parameters:

Parameter Name Type Description
code Int Error code returned for database query
message String Error message returned for database query
CdbInstanceId 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.
databaseList Array Database information list

4. Error Codes

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

Error code Error Message Description
9003 InvalidParameter Incorrect parameter

5. Example

Input

https://cdb.api.qcloud.com/v2/index.php?Action=QueryCdbDatabases
&<Common request parameters>
&cdbInstanceIds.0=cdb-f35wr6wj

Output

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "data": [
        {
            "code": 0,
            "message": "ok",
            "cdbInstanceId": "cdb-f35wr6wj",
            "databaseList": [
                "information_schema",
                "mysql",
                "performance_schema",
                "test"
            ],
        }
    ]
}