Query Database Mode

Last updated: 2017-12-14 10:52:23

PDF

1. API Description

This API (GetCdbInstanceSchema) is used to query the details of database schema.
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 GetCdbInstanceSchema.

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 the uInstanceId field value in the output parameter.
dbName No String The name of the database whose schema needs to be queried
tbName No String The name of the table whose schema needs to be queried. If tbName is specified, dbName must also be specified

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

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
9531 ConnectRefused Instance connection is refused
9532 ConnectErrorUnknown Instance connection error
9533 SqlExecFailUnknown Database operation failed
9572 InstanceNotExists Instance does not exist

5. Example

Input

https://cdb.api.qcloud.com/v2/index.php?Action=GetCdbInstanceSchema
&<Common request parameters>
&cdbInstanceId=cdb-ainl9ibe

Output

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "data": [
        "test"
    ]
}