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, import the source cluster ID to search for the source poolId |
| UniqVpcId | No | String | ID of the VPC network it belongs to |
| UniqSubnetId | No | String | Subnet ID. |
| ClusterName | No | String | Cluster name, length less than 64 characters. Each character value range: uppercase/lowercase letters, digits, special symbols ('-','_','.') |
| RollbackId | No | Integer | Snapshot rollback refers to snapshotId; point-in-time rollback refers to queryId. A value of 0 indicates the need to determine 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 need to 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. Currently supports character_set_server (utf8 | latin1 | gbk | utf8mb4) and lower_case_table_names. 1: case-insensitive, 0: case-sensitive |
| ParamTemplateId | No | Integer | Parameter template ID, which can be obtained by querying parameter template information through DescribeParamTemplates |
| InstanceInitInfos.N | No | Array of InstanceInitInfo | Instance initialization configuration information, mainly used for selecting different specification instances during cluster purchase |
| DealMode | No | Integer | 0-Place order and pay 1-Place order |
| PayMode | No | Integer | Pay-per-compute-node model. Valid values: 0 (pay-as-you-go) and 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 | Information of the source read-only instance |
| ProjectId | No | Integer | Project ID. |
| AutoArchive | No | String | Whether archive is enabled. Optional range: |
| FromSaveBackup | No | Boolean | Whether to restore from a saved backup |
| SyncWay | No | String | Synchronization method. Available values: async, semisync, sync. Async as a default. |
| SemiSyncTimeout | No | Integer | Semi-sync timeout in milliseconds. To ensure business stability, semi-sync replication has a degradation logic. If the primary availability zone cluster exceeds this timeout period while waiting for the standby availability zone cluster to confirm a transaction, the replication method will degrade to asynchronous replication. Value range: [1000, 4294967295] Unit: ms Default value: 10000 |
| SlaveZone | No | String | Secondary AZ |
| 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. To obtain resource IDs, please use the dealNames field to query the DescribeResourcesByDealName API) |
| ClusterIds | Array of String | Cluster ID list (this field is no longer maintained; please use the dealNames field to query the DescribeResourcesByDealName 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. |
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 and pay the order. |
| FailedOperation.InsufficientBalance | Insufficient account balance. |
| FailedOperation.OperationFailedError | Operation failed. Try again later. If the issue persists, contact customer service. |
| FailedOperation.QuerySpecBySpecCodeError | Specification information query failed. |
| FailedOperation.TradeCreateOrderError | Failed to create and pay for the order. Try again later. If the issue persists, contact customer service. |
| InternalError.DbOperationFailed | Query database failed. |
| InternalError.GetSubnetFailed | Failed to obtain the subnet. |
| InternalError.GetVpcFailed | Failed to get the VPC. |
| InternalError.InternalHttpServerError | http request execution error. |
| InternalError.UnknownError | Unknown internal error. |
| InvalidParameterValue.DBTypeNotFound | Unsupported instance type. |
| InvalidParameterValue.IllegalPassword | The password does not meet requirements. |
| InvalidParameterValue.InvalidDBVersion | Invalid instance version. |
| InvalidParameterValue.InvalidParameterValueError | Parameter value is invalid. |
| InvalidParameterValue.InvalidSpec | Invalid instance specification. |
| InvalidParameterValue.InvalidZoneIdError | Invalid AZ. |
| InvalidParameterValue.ProjectIdNotFound | ProjectId not found |
| InvalidParameterValue.RegionZoneUnavailable | The selected region and availability zone are unavailable. |
| InvalidParameterValue.SubnetNotFound | Subnet not found. |
| InvalidParameterValue.VpcNotFound | The selected VPC network is not found. |
| LimitExceeded.UserInstanceLimit | Number of user instances exceeds the limit. |
| OperationDenied.InsufficientBalanceError | Insufficient account balance. |
| OperationDenied.UserNotAuthenticatedError | User not verified with real-name authentication. Please proceed with real-name authentication before purchase. |
| UnauthorizedOperation.NotRealNameAccount | Non-verified users are prohibited from purchasing. |
| UnauthorizedOperation.PermissionDenied | CAM authentication failed. |
文档反馈