tencent cloud



Last updated: 2022-08-17 15:58:06

1. API Description

Domain name for API request: cdb.tencentcloudapi.com.

This API is used to query the details of a TencentDB instance rollback task.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeRollbackTaskDetail.
Version Yes String Common Params. The value used for this API: 2017-03-20.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID, which is the same as the instance ID displayed in the TencentDB Console. You can use the DescribeDBInstances API to query the ID.
AsyncRequestId No String Async task ID.
Limit No Integer Pagination parameter, i.e., the number of entries to be returned for a single request. Default value: 20. Maximum value: 100.
Offset No Integer Pagination offset. Default value: 0.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of eligible entries.
Items Array of RollbackTask Rollback task details.
Note: this field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying rollback task details

Input Example

&<Common request parameters>

Output Example

    "Response": {
        "TotalCount": 2,
        "Items": [
                "Info": "batch rollback success",
                "Status": "SUCCESS",
                "Progress": 100,
                "StartTime": "2020-04-22 10:01:23",
                "EndTime": "2020-04-22 10:06:25",
                "Detail": [
                        "InstanceId": "cdb-qwer1234",
                        "Strategy": "full",
                        "RollbackTime": "2020-04-22 10:00:57",
                        "Databases": [],
                        "Tables": [
                                "Table": [
                                        "TableName": "sbtest1",
                                        "NewTableName": "sbtest1_bak"
                                        "TableName": "sbtest2",
                                        "NewTableName": "sbtest2_bak"
                                "Database": "dbtest_bak"
        "RequestId": "1ac120c8-744a-4c15-be4e-4431511c0233"

5. Developer Resources


TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
CdbError.DatabaseError Backend database error.
InternalError.CdbError System error.
InvalidParameter.ResourceNotExists The resource does not exist.
OperationDenied.UserHasNoStrategy This account is not authorized to access the requested resource.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support