1. 接口描述
接口请求域名： cdb.tencentcloudapi.com 。
本接口(DescribeInstanceUpgradeType)用于查询数据库实例升级类型。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeInstanceUpgradeType。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例id 示例值：cdb-xxx |
| DstCpu | 是 | Float | 目标实例cpu 示例值：2 |
| DstMemory | 是 | Integer | 目标实例内存 示例值：4000 |
| DstDisk | 是 | Integer | 目标实例磁盘 示例值：8000 |
| DstVersion | 否 | String | 目标实例版本 示例值：5.7 |
| DstDeployMode | 否 | Integer | 目标实例部署模型 示例值：0 |
| DstProtectMode | 否 | Integer | 目标实例复制类型 示例值：0 |
| DstSlaveZone | 否 | Integer | 目标实例备机1可用区 示例值：100001 |
| DstBackupZone | 否 | Integer | 目标实例备机2可用区 示例值：100001 |
| DstCdbType | 否 | String | 目标实例类型 示例值：CUSTOM |
| DstZoneId | 否 | Integer | 目标实例主可用区 示例值：100001 |
| NodeDistribution | 否 | NodeDistribution | 独享集群CDB实例的节点分布情况 |
| ClusterTopology | 否 | ClusterTopology | 集群版的节点拓扑配置 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例id 示例值：cdb-xxx |
| UpgradeType | String | 实例升级类型 示例值：Trsf |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询数据库实例升级类型
输入示例
POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstanceUpgradeType
<公共请求参数>
{
"InstanceId": "cdb-xxxxx",
"DstCpu": 1,
"DstMemory": 1000,
"DstDisk": 200,
"DstVersion": "8.0",
"DstProtectMode": 0,
"DstDeployMode": 0,
"DstSlaveZone": 100003,
"DstBackupZone": 0,
"DstCdbType": "CUSTOM"
}输出示例
{
"Response": {
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
"InstanceId": "cdb-xxx",
"UpgradeType": "Trsf"
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
