DescribeRollbackTaskDetail

Download PDF

DescribeRollbackTaskDetail

最后更新时间：2024-01-30 10:25:40

下载PDF

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	No	String	Common Params. This parameter is not required for this API.
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 the details of a rollback task

Input Example

POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRollbackTaskDetail
<Common request parameters>

{
    "InstanceId": "cdb-qwer1234",
    "Limit": "1"
}

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

SDK

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

Command Line Interface

Tencent Cloud CLI 3.0

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.

tencent cloud

Recent Pages

DescribeRollbackTaskDetail

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Querying the details of a rollback task

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？

tencent cloud

注册

登录

Recent Pages

DescribeRollbackTaskDetail

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Querying the details of a rollback task

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？