Release Notes
Product Announcements
Domain name for API request: cynosdb.intl.tencentcloudapi.com.
This API is used to roll back to a new cluster.
A maximum of 20 requests can be initiated per second for this API.
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: RollbackToNewCluster. |
| 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. |
| Zone | Yes | String | AZ. |
| OriginalClusterId | Yes | String | During rollback, pass in the source cluster ID to find the source pool ID. |
| UniqVpcId | No | String | VPC ID. |
| UniqSubnetId | No | String | Subnet ID. |
| ClusterName | No | String | The cluster name should contain fewer than 64 characters. Valid values for each character: uppercase/lowercase letters, digits, and special characters ('-', '_', and '.'). |
| RollbackId | No | Integer | Rolls back by snapshot, which indicates snapshotId; rolls back by time point, which indicates queryId. When the value of queryId is 0, it indicates that the validity of the time point needs to be verified. |
| ExpectTime | No | String | Rolls back by time point, which indicates the specified time; rolls back by snapshot, which indicates the snapshot time. |
| AutoVoucher | No | Integer | Whether to select promo vouchers automatically. 1: yes; 0: no. The default value is 0. |
| ResourceTags.N | No | Array of Tag | Information about the tag array to be bound during cluster creation. |
| DbMode | No | String | Database type. When the value of DbType is MYSQL, the valid values are NORMAL and SERVERLESS (the default value is NORMAL). |
| MinCpu | No | Float | This parameter is required when the value of DbMode is SEVERLESS. For the settings of the minimum CPU value, refer to the value returned by the DescribeServerlessInstanceSpecs API for the valid value. |
| MaxCpu | No | Float | This parameter is required when the value of DbMode is SEVERLESS. For the settings of the maximum CPU value, refer to the value returned by the DescribeServerlessInstanceSpecs API for the valid value. |
| AutoPause | No | String | Specifies whether the cluster is automatically paused when the value of DbMode is SEVERLESS. Valid values: yes; no. The default value is yes. |
| AutoPauseDelay | No | Integer | Specifies the delay for automatic cluster pause (in seconds) when the value of DbMode is SEVERLESS. Value range: [600, 691200]. The default value is 600. |
| SecurityGroupIds.N | No | Array of String | Security group ID array. |
| AlarmPolicyIds.N | No | Array of String | Alarm policy ID array. |
| ClusterParams.N | No | Array of ParamItem | Parameter array. The character_set_server (utf8 | latin1 | gbk | utf8mb4) is currently supported. lower_case_table_names: 1 - case-insensitive; 0 - case-sensitive. |
| ParamTemplateId | No | Integer | Parameter template ID, which can be obtained through the DescribeParamTemplates API. |
| InstanceInitInfos.N | No | Array of InstanceInitInfo | Instance initialization configuration information, which is mainly used for selecting different instance specifications during cluster purchase. |
| DealMode | No | Integer | 0 - place an order and pay; 1 - place an order. |
| PayMode | No | Integer | Compute node billing mode: 0 - pay-as-you-go; 1 - prepaid. |
| TimeSpan | No | Integer | Time. |
| TimeUnit | No | String | Unit. |
| RollbackDatabases.N | No | Array of RollbackDatabase | Rollback database information. |
| RollbackTables.N | No | Array of RollbackTable | Rollback table information. |
| OriginalROInstanceList.N | No | Array of String | Source read-only instance information. |
| ProjectId | No | Integer | Project ID |
| AutoArchive | No | String | Whether to enable archiving. Valid values: yes; no. The default value is yes. |
| Parameter Name | Type | Description |
|---|---|---|
| TranId | String | Frozen transaction ID. |
| DealNames | Array of String | Order ID |
| ResourceIds | Array of String | Resource ID list (this field is no longer maintained. please use the dealNames field and the DescribeResourcesByDealName query API to obtain resource ids.). |
| ClusterIds | Array of String | Cluster ID list. this field is no longer maintained. please use the dealNames field and the DescribeResourcesByDealName query API to get the cluster ID. |
| BigDealIds | Array of String | Large order number. |
| 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. |
This example shows you how to roll back to the new cluster.
POST / HTTP/1.1
Host: cynosdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RollbackToNewCluster
<Common request parameters>
{
"Zone": "ap-guangzhou-3",
"ClusterName": "",
"ProjectId": 0,
"PayMode": 0,
"OriginalClusterId": "cynosdbmysql-0fs2nhc7",
"RollbackId": 64142,
"InstanceInitInfos": [
{
"Cpu": 1,
"Memory": 1,
"InstanceType": "rw",
"InstanceCount": 1
}
],
"UniqVpcId": "vpc-ns1jr6ff",
"UniqSubnetId": "subnet-gncsqeuq"
}{
"Response": {
"BigDealIds": [],
"ClusterIds": [],
"DealNames": [
"20250928456021591536011"
],
"RequestId": "0c646e65-3597-44d7-b68b-d43391eedb33",
"ResourceIds": [],
"TranId": "20250928456021591536021"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.CreateOrder | Failed to create the order and make a payment. |
| FailedOperation.InsufficientBalance | Insufficient account balance |
| FailedOperation.OperationFailedError | Operation failed. Try again later. If the problem persists, contact customer service. |
| FailedOperation.QuerySpecBySpecCodeError | Failed to query specifications. |
| FailedOperation.TradeCreateOrderError | Failed to create the order and make a payment. Please try again later. If the problem persists, please contact customer service. |
| InternalError.DbOperationFailed | Failed to query the database. |
| InternalError.GetSubnetFailed | Failed to get the subnet. |
| InternalError.GetVpcFailed | Failed to get the VPC. |
| InternalError.InternalHttpServerError | An exception occurred while executing the HTTP request. |
| InternalError.UnknownError | Unknown internal error. |
| InvalidParameterValue.DBTypeNotFound | Unsupported instance type. |
| InvalidParameterValue.IllegalPassword | The password does not meet the requirement. |
| InvalidParameterValue.InvalidDBVersion | Invalid instance version. |
| InvalidParameterValue.InvalidParameterValueError | Invalid parameter value. |
| InvalidParameterValue.InvalidSpec | Invalid instance specification. |
| InvalidParameterValue.InvalidZoneIdError | Invalid AZ |
| InvalidParameterValue.ProjectIdNotFound | The ProjectId was not found. |
| InvalidParameterValue.RegionZoneUnavailable | The selected region and AZ are unavailable. |
| InvalidParameterValue.SubnetNotFound | The selected subnet could not be found. |
| InvalidParameterValue.VpcNotFound | The selected VPC could not be found. |
| LimitExceeded.UserInstanceLimit | The number of instances exceeds the limit. |
| OperationDenied.InsufficientBalanceError | Insufficient account balance. |
| OperationDenied.UserNotAuthenticatedError | You need to verify your identity to make a purchase. |
| UnauthorizedOperation.NotRealNameAccount | Users who haven't completed identity verification can’t make purchases. |
| UnauthorizedOperation.PermissionDenied | CAM authentication failed. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback