RollBackCluster

Last updated:2025-11-13 20:51:43

RollBackCluster

Last updated: 2025-11-13 20:51:43

1. API Description

Domain name for API request: cynosdb.intl.tencentcloudapi.com.

This API is used to perform cluster rollback.

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: RollBackCluster.
Version	Yes	String	Common Params. The value used for this API: 2019-01-07.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
ClusterId	Yes	String	Cluster ID.
RollbackStrategy	Yes	String	Rollback policy. timeRollback - roll back by time point; snapRollback - roll back by backup file.
RollbackId	Yes	Integer	Backup file ID. This parameter is required when the rollback policy is rolling back by backup file.
ExpectTime	No	String	Expected rollback time. This parameter is required when the rollback policy is timeRollback (roll back by time point).
ExpectTimeThresh	No	Integer	Expected threshold (deprecated).
RollbackDatabases.N	No	Array of RollbackDatabase	List of rollback databases.
RollbackTables.N	No	Array of RollbackTable	List of rollback databases and tables.
RollbackMode	No	String	Mode of rolling back by time point. full: normal; db: fast; table: ultra-fast (the default value is normal).

3. Output Parameters

Parameter Name	Type	Description
FlowId	Integer	Task flow ID.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Cluster Rollback

This example shows you how to perform a cluster rollback.

Input Example

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

{
    "RollbackId": 1,
    "ClusterId": "cynosdbmysql-j9i41hff",
    "ExpectTimeThresh": 1,
    "RollbackStrategy": "snapRollback",
    "RollbackTables": [
        {
            "Tables": [
                {
                    "OldTable": "old_table",
                    "NewTable": "new_table"
                }
            ],
            "Database": "old_db1"
        }
    ],
    "ExpectTime": "2022-01-20 00:00:00",
    "RollbackDatabases": [
        {
            "NewDatabase": "new_db2",
            "OldDatabase": "old_db2"
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "347698da-03e4-4078-8d96-9a8b219c01a5",
        "FlowId": "147283"
    }
}

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
FailedOperation.FlowCreateError	Failed to create a task. Try again later. If the problem persists, contact customer service.
FailedOperation.OperationFailedError	Operation failed. Try again later. If the problem persists, contact customer service.
InternalError.DbOperationFailed	Failed to query the database.
InvalidParameterValue	The parameter value is invalid.
InvalidParameterValue.InvalidParameterValueError	Invalid parameter value.
ResourceNotFound.ClusterNotFoundError	The cluster does not exist.
ResourceUnavailable.InstanceLockFail	Failed to lock the instance, so the operation cannot be performed temporarily.
ResourceUnavailable.InstanceStatusAbnormal	The instance is exceptional, so the operation cannot be performed temporarily.
UnauthorizedOperation.PermissionDenied	CAM authentication failed.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud