1. 接口描述
接口请求域名: tdmysql.tencentcloudapi.com 。
本接口(UpgradeInstance)提供纵向扩容实例功能
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:UpgradeInstance。 |
| Version | 是 | String | 公共参数,本接口取值:2021-11-22。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例ID 示例值:"tdsql3-d8fffc3c" |
| SpecCode | 是 | String | 实例规格码 示例值:1c2g |
| Disk | 是 | Integer | 存储节点磁盘容量,单位GB 示例值:500 |
| StorageNodeCpu | 否 | Integer | 存储节点CPU核数 示例值:2 |
| StorageNodeMem | 否 | Integer | 存储节点内存大小 示例值:4 |
| StorageType | 否 | String | 磁盘类型,需要修改磁盘类型时传 示例值:"CLOUD_TCS" |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| FlowId | Integer | 任务ID 示例值:4295036957 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 加强型实例纵向变配
输入示例
POST / HTTP/1.1
Host: tdmysql.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpgradeInstance
<公共请求参数>
{
"InstanceId": "tdsql3-bcedf765",
"SpecCode": "1c2g",
"Disk": 20,
"StorageNodeCpu": 1,
"StorageNodeMem": 2,
"StorageType": "CLOUD_TCS"
}
输出示例
{
"Response": {
"FlowId": 4295036957,
"RequestId": "c2341b01-296a-4fd3-9f5c-009c0f232d09"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.CamAuthError | CAM鉴权错误。 |
| AuthFailure.CheckCamAuthError | CAM鉴权请求参数检查失败。 |
| AuthFailure.UnauthorizedOperation | CAM鉴权失败。 |
| FailedOperation.CheckSupportActionError | 当前实例版本不支持该接口。 |
| FailedOperation.CreateFlowError | 创建任务失败。 |
| FailedOperation.DBQueryInstanceError | 查询实例数据失败。 |
| FailedOperation.LockInstanceError | 锁定实例失败。 |
| InvalidParameterValue.CheckSpecError | 实例规格校验错误。 |
| LimitExceeded.OutOfSpecLimitError | 规格超过限制。 |
| OperationDenied.CheckDecreaseSpecError | 暂不支持实例规格缩容操作。 |
| OperationDenied.InstanceStatusError | 实例状态错误。 |