1. 接口描述
接口请求域名： cynosdb.tencentcloudapi.com 。
本接口（UpgradeInstance）用于实例变配。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：UpgradeInstance。 |
| Version | 是 | String | 公共参数，本接口取值：2019-01-07。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley 。 |
| InstanceId | 是 | String | 实例ID 示例值：cynosdbpg-ins-n7ocdslw |
| Cpu | 是 | Integer | 数据库CPU 示例值：2 |
| Memory | 是 | Integer | 数据库内存，单位GB 示例值：4 |
| UpgradeType | 是 | String | 升级类型：upgradeImmediate，upgradeInMaintain 示例值：upgradeImmediate |
| DeviceType | 否 | String | 实例机器类型 |
| StorageLimit | 否 | Integer | 该参数已废弃 示例值：1000 |
| AutoVoucher | 否 | Integer | 是否自动选择代金券 1是 0否 默认为0 示例值：0 |
| DbType | 否 | String | 该参数已废弃 示例值：MYSQL |
| DealMode | 否 | Integer | 交易模式 0-下单并支付 1-下单 示例值：0 |
| UpgradeMode | 否 | String | NormalUpgrade：普通变配，FastUpgrade：极速变配，若变配过程判断会造成闪断，变配流程会终止。 示例值：NormalUpgrade |
| UpgradeProxy | 否 | UpgradeProxy | proxy同步升级 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TranId | String | 冻结流水ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：MyTranId |
| BigDealIds | Array of String | 大订单号 注意：此字段可能返回 null，表示取不到有效值。 示例值：[123456] |
| DealNames | Array of String | 订单号 示例值：[234567] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 实例变配
输入示例
POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpgradeInstance
<公共请求参数>
{
"InstanceId": "cynosdbmysql-ins-n7ocdslw",
"UpgradeType": "upgradeImmediate",
"Cpu": 2,
"Memory": 4,
"UpgradeProxy": {
"Cpu": 4,
"Mem": 8000,
"ReloadBalance": "auto",
"ProxyZones": [
{
"ProxyNodeZone": "ap-guangzhou-3",
"ProxyNodeCount": 1
}
]
}
}输出示例
{
"Response": {
"BigDealIds": [],
"DealNames": [
"20241025054071351304161"
],
"RequestId": "588fbc90-61a4-4125-bc70-65a3f8d1327e",
"TranId": "20241025054071351304171"
}
}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.DatabaseAccessError | 数据库访问失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
| FailedOperation.OperationFailedError | 操作失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
| FailedOperation.TradeCreateOrderError | 创建并支付订单失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
| InternalError.SystemError | 系统内部错误。 |
| InternalError.UnknownError | 未知的内部错误。 |
| InvalidParameterValue.DBTypeNotFound | 不支持的实例类型。 |
| InvalidParameterValue.InstanceNotFound | 实例不存在。 |
| InvalidParameterValue.ParamError | 参数错误。 |
| OperationDenied.ClusterOpNotAllowedError | 由于操作禁止，当前集群不允许该操作。 |
| OperationDenied.InstanceStatusDeniedError | 实例当前状态不允许该操作。 |
| OperationDenied.InsufficientBalanceError | 账号余额不足。 |
| ResourceNotFound.ClusterNotFoundError | 集群不存在。 |
| UnauthorizedOperation.PermissionDenied | CAM鉴权不通过。 |
