tencent cloud

APIs

RollBackCluster

下载
聚焦模式
字号
最后更新时间: 2026-10-28 10:19:20

1. API Description

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

This API is used to roll back a cluster.

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: rollback by time point. snapRollback: rollback by backup file.
RollbackId No Integer Backup file ID.
Required when the rollback policy is rollback by backup file.
ExpectTime No String Expected restore time.
Required if the rollback policy is timeRollback for rollback by time point.
ExpectTimeThresh No Integer Expected threshold (abandoned)
RollbackDatabases.N No Array of RollbackDatabase Database list for rollback
RollbackTables.N No Array of RollbackTable List of rollback database tables
RollbackMode No String Point-in-Time Restore Mode. full: ordinary; db: quick; table: ultra-fast (ordinary is selected by default)
VaultId No String Safe id

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

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

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 the process. Please retry later. If the issue continues, contact customer service.
FailedOperation.OperationFailedError Operation failed. Try again later. If the issue persists, contact customer service.
InternalError.DbOperationFailed Query database failed.
InvalidParameterValue Parameter value error.
InvalidParameterValue.InvalidParameterValueError Parameter value is invalid.
ResourceNotFound.ClusterNotFoundError The cluster does not exist.
ResourceUnavailable.InstanceLockFail Failed to lock the instance. It is temporarily inoperable.
ResourceUnavailable.InstanceStatusAbnormal Instance status is abnormal and temporarily not operable.
UnauthorizedOperation.PermissionDenied CAM authentication failed.

帮助和支持

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

填写满意度调查问卷,共创更好文档体验。

文档反馈