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, input the source cluster ID to search for the source poolId |
| UniqVpcId | No | String | VPC network ID |
| UniqSubnetId | No | String | Subnet ID |
| ClusterName | No | String | Cluster name, length less than 64 characters. Each character value ranges from uppercase/lowercase letters, digits, to special symbols ('-', '_', '.'). |
| RollbackId | No | Integer | Snapshot rollback means snapshotId; point-in-time rollback means queryId. A value of 0 indicates requirement to judge whether the time point is valid. |
| ExpectTime | No | String | Point-in-time rollback, specified time; snapshot rollback, snapshot time |
| AutoVoucher | No | Integer | Whether to automatically select a voucher. 1: Yes; 0: No. Default is 0. |
| ResourceTags.N | No | Array of Tag | tag Array information that should be bound for cluster creation |
| DbMode | No | String | DB type |
| MinCpu | No | Float | Required when DbMode is SEVERLESS |
| MaxCpu | No | Float | Required when DbMode is SEVERLESS: |
| AutoPause | No | String | When DbMode is SEVERLESS, whether to automatically pause within specified clusters. Optional range |
| AutoPauseDelay | No | Integer | When DbMode is SEVERLESS, specify the delay for Cluster Auto-Pause in seconds, optional range [600,691200] |
| 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, temporarily supports character_set_server (utf8 |
| ParamTemplateId | No | Integer | Parameter template ID. The parameter template ID can be obtained through querying parameter template information DescribeParamTemplates. |
| InstanceInitInfos.N | No | Array of InstanceInitInfo | Instance initialization configuration information is mainly used to select different specification instances during cluster purchase. |
| DealMode | No | Integer | 0-Place order and pay 1-Placing order |
| PayMode | No | Integer | Pay-per-compute-node model: 0-Pay-As-You-Go, 1-Prepayment |
| TimeSpan | No | Integer | Time |
| TimeUnit | No | String | Unit |
| RollbackDatabases.N | No | Array of RollbackDatabase | Rollback database info |
| RollbackTables.N | No | Array of RollbackTable | Roll back table information |
| OriginalROInstanceList.N | No | Array of String | Original ro instance information |
| ProjectId | No | Integer | Project ID. |
| AutoArchive | No | String | Whether to enable archive. Optional range |
| FromSaveBackup | No | Boolean | Whether to restore from the saved backup |
| 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 to query the API DescribeResourcesByDealName to obtain resource IDs.) |
| ClusterIds | Array of String | Cluster ID list (This field is no longer maintained. Please use the dealNames field to query the API DescribeResourcesByDealName to obtain cluster IDs.) |
| BigDealIds | Array of String | Large order number Note: This field may return null, indicating that no valid values can be obtained. |
| 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. |
Rollback To 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",
"FromSaveBackup": false,
"RollbackId": 64142,
"InstanceInitInfos": [
{
"Cpu": 1,
"Memory": 1,
"DeviceType": "common",
"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. |
文档反馈