Query Available Callback Time

Last updated: 2017-12-14 11:19:24

PDF

1. API Description

This API (QueryCdbRollbackRangeTime) is used to query the time range available for the rollback of CDB instances.
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 QueryCdbRollbackRangeTime.

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 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 message

Parameter data is composed as follows:

Parameter Name Type Description
code Int Error code returned for database query
message String Error message returned for database query
cdbInstanceId String Instance ID
times Array Time range available for rollback
times.begin String Start time available for rollback of the instance, such as: 2016-10-29 01:06:04
times.end String End time available for rollback of the instance, such as: 2016-11-02 11:44:47

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
11041 InternalError.CDBNotExist CDB instance does not exist

5. Example

Input

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

Output

{
    "code":"0",
    "message":"",
    "codeDesc":"Success",
    "data":[
        {
            "code":"0",
            "message":"ok",
            "cdbInstanceId":"cdb-mo64xu70",
            "times":[
                {
                    "begin":"2016-10-29 01:06:04",
                    "end":"2016-11-02 11:44:47"
                }
            ]
        }
    ]
}