1. 接口描述
接口请求域名: cynosdb.tencentcloudapi.com 。
本接口(RollbackToNewCluster)用于回档到新集群。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:RollbackToNewCluster。 |
Version | 是 | String | 公共参数,本接口取值:2019-01-07。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: 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 。 |
Zone | 是 | String | 可用区 示例值:ap-guangzhou-3 |
OriginalClusterId | 是 | String | 回档时,传入源集群ID,用于查找源poolId 示例值:cynosdbmysql-gs629njx |
UniqVpcId | 否 | String | 所属VPC网络ID 示例值:vpc-1ptuei0b |
UniqSubnetId | 否 | String | 所属子网ID 示例值:subnet-1tmw9t4o |
ClusterName | 否 | String | 集群名称,长度小于64个字符,每个字符取值范围:大/小写字母,数字,特殊符号('-','_','.') 示例值:MyClusterName |
RollbackId | 否 | Integer | 快照回档,表示snapshotId;时间点回档,表示queryId,为0,表示需要判断时间点是否有效 示例值:0 |
ExpectTime | 否 | String | 时间点回档,指定时间;快照回档,快照时间 示例值:2021-04-26 18:13:10 |
AutoVoucher | 否 | Integer | 是否自动选择代金券 1是 0否 默认为0 示例值:0 |
ResourceTags.N | 否 | Array of Tag | 集群创建需要绑定的tag数组信息 示例值:[{"TagKey":"PayMode","TagValue":"PayMode0"},{"TagKey":"StoragePayMode","TagValue":"StoragePayMode0"}] |
DbMode | 否 | String | Db类型 当DbType为MYSQL时可选(默认NORMAL): 示例值:NORMAL |
MinCpu | 否 | Float | 当DbMode为SEVERLESS时必填 cpu最小值,可选范围参考DescribeServerlessInstanceSpecs接口返回 示例值:1.0 |
MaxCpu | 否 | Float | 当DbMode为SEVERLESS时必填: cpu最大值,可选范围参考DescribeServerlessInstanceSpecs接口返回 示例值:2.0 |
AutoPause | 否 | String | 当DbMode为SEVERLESS时,指定集群是否自动暂停,可选范围 默认值:yes 示例值:yes |
AutoPauseDelay | 否 | Integer | 当DbMode为SEVERLESS时,指定集群自动暂停的延迟,单位秒,可选范围[600,691200] 默认值:600 示例值:600 |
SecurityGroupIds.N | 否 | Array of String | 安全组id数组 示例值:["sg-ikto3761","sg-ikto52u1"] |
AlarmPolicyIds.N | 否 | Array of String | 告警策略Id数组 示例值:["policy-8hbxwvxe","policy-3bs6vxe4"] |
ClusterParams.N | 否 | Array of ParamItem | 参数数组,暂时支持character_set_server (utf8|latin1|gbk|utf8mb4) ,lower_case_table_names,1-大小写不敏感,0-大小写敏感 示例值:[{"CurrentValue":"utf8mb4","ParamName":"character_set_server"},{"CurrentValue":"1","ParamName":"lower_case_table_names"}] |
ParamTemplateId | 否 | Integer | 参数模板ID,可以通过查询参数模板信息DescribeParamTemplates获得参数模板ID 示例值:0 |
InstanceInitInfos.N | 否 | Array of InstanceInitInfo | 实例初始化配置信息,主要用于购买集群时选不同规格实例 示例值:[{"Cpu":1,"InstanceCount":1,"InstanceType":"rw","Memory":1}] |
DealMode | 否 | Integer | 0-下单并支付 1-下单 示例值:0 |
PayMode | 否 | Integer | 计算节点付费模式:0-按量计费,1-预付费 示例值:0 |
TimeSpan | 否 | Integer | 时间 示例值:12 |
TimeUnit | 否 | String | 单位 示例值:m |
RollbackDatabases.N | 否 | Array of RollbackDatabase | 回档库信息 示例值:[{"NewDatabase":"db2","OldDatabase":"db1"}] |
RollbackTables.N | 否 | Array of RollbackTable | 回档表信息 示例值:[{"Database":"db1","Tables":[{"OldTable":"table1","newTable":"table2"}]}] |
OriginalROInstanceList.N | 否 | Array of String | 原ro实例信息 示例值:["cynosdbmysql-ins-7xbwg29x"] |
ProjectId | 否 | Integer | 项目id 示例值:10 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TranId | String | 冻结流水ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:20190522160000003106844584180998 |
DealNames | Array of String | 订单号 注意:此字段可能返回 null,表示取不到有效值。 示例值:["20190522112283"] |
ResourceIds | Array of String | 资源ID列表(该字段已不再维护,请使用dealNames字段查询接口DescribeResourcesByDealName获取资源ID) 注意:此字段可能返回 null,表示取不到有效值。 示例值:["cynosdbpg-ins-67rmucgk"] |
ClusterIds | Array of String | 集群ID列表(该字段已不再维护,请使用dealNames字段查询接口DescribeResourcesByDealName获取集群ID) 注意:此字段可能返回 null,表示取不到有效值。 示例值:["cynosdbmysql-sls-9nts65r2"] |
BigDealIds | Array of String | 大订单号 注意:此字段可能返回 null,表示取不到有效值。 示例值:["20241226519077105329731"] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 回档到新集群
输入示例
POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RollbackToNewCluster
<公共请求参数>
{
"Zone": "ap-guangzhou-5",
"UniqVpcId": "vpc-tsnp6wjk",
"UniqSubnetId": "subnet-tsrq2i9e",
"ClusterName": "MyClusterName",
"RollbackId": 1,
"OriginalClusterId": "cynosdbmysql-tsr2ubsj",
"ExpectTime": "2024-10-01 12:01:01",
"AutoVoucher": 0,
"ResourceTags": [
{
"TagKey": "tagKey-1",
"TagValue": "tagValue-1"
}
],
"DbMode": "MYSQL",
"MinCpu": 0,
"MaxCpu": 0,
"AutoPause": "yes",
"AutoPauseDelay": 0,
"SecurityGroupIds": [
"sg-sjcgywls"
],
"AlarmPolicyIds": [
"policy-jylgsf32"
],
"ClusterParams": [
{
"ParamName": "binlog_cache_size",
"CurrentValue": "200",
"OldValue": "3000"
}
],
"ParamTemplateId": 0,
"InstanceInitInfos": [
{
"Cpu": 1,
"Memory": 2,
"InstanceType": "rw",
"InstanceCount": 1,
"MinRoCount": 1,
"MaxRoCount": 2,
"MinRoCpu": 1,
"MaxRoCpu": 4
}
],
"DealMode": 0
}
输出示例
{
"Response": {
"TranId": "12635123871523612735",
"DealNames": [
"126351238715236127011"
],
"ResourceIds": [
"cynosdbmysql-ins-tsk5bs6w"
],
"ClusterIds": [
"cynosdbmysql-kshc2bxu"
],
"BigDealIds": [
"12635123871523612735012"
],
"RequestId": "91331f25-7342-4c58-925c-3deb5aee4a61"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.CreateOrder | 创建并支付订单失败。 |
FailedOperation.InsufficientBalance | 账号余额不足。 |
FailedOperation.OperationFailedError | 操作失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
FailedOperation.QuerySpecBySpecCodeError | 规格信息查询失败。 |
FailedOperation.TradeCreateOrderError | 创建并支付订单失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
InternalError.DbOperationFailed | 查询数据库失败。 |
InternalError.GetSubnetFailed | 获取子网失败。 |
InternalError.GetVpcFailed | 获取VPC失败。 |
InternalError.InternalHttpServerError | http请求执行异常。 |
InternalError.UnknownError | 未知的内部错误。 |
InvalidParameterValue.DBTypeNotFound | 不支持的实例类型。 |
InvalidParameterValue.IllegalPassword | 密码不符合要求。 |
InvalidParameterValue.InvalidDBVersion | 实例版本非法。 |
InvalidParameterValue.InvalidParameterValueError | 参数值无效。 |
InvalidParameterValue.InvalidSpec | 实例规格非法。 |
InvalidParameterValue.InvalidZoneIdError | 无效的可用区。 |
InvalidParameterValue.ProjectIdNotFound | 找不到该ProjectId |
InvalidParameterValue.RegionZoneUnavailable | 所选地域和可用区不可用。 |
InvalidParameterValue.SubnetNotFound | 找不到所选子网。 |
InvalidParameterValue.VpcNotFound | 找不到所选VPC网络。 |
LimitExceeded.UserInstanceLimit | 用户实例个数超出限制。 |
OperationDenied.InsufficientBalanceError | 账号余额不足。 |
OperationDenied.UserNotAuthenticatedError | 用户未进行实名认证,请先进行实名认证才可购买。 |
UnauthorizedOperation.NotRealNameAccount | 非实名用户禁止购买。 |
UnauthorizedOperation.PermissionDenied | CAM鉴权不通过。 |