Tencent Cloud

search by keyword

Recent Pages

Documentation

DescribeRollbackTaskDetail

Last updated: 2020-05-15 11:35:04

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.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cdb.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: DescribeRollbackTaskDetail.
Version	Yes	String	Common parameter. The value used for this API: 2017-03-20.
Region	Yes	String	Common parameter. 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

https://cdb.tencentcloudapi.com/?Action=DescribeRollbackTaskDetail
&InstanceId=cdb-qwer1234
&Limit=1
&<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

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.