1. 接口描述
接口请求域名： ckafka.tencentcloudapi.com 。
查询实例变配类型
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeModifyType。 |
| Version | 是 | String | 公共参数，本接口取值：2019-08-19。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | ckafka集群实例Id 示例值：ckafka-test |
| BandWidth | 是 | Integer | 升配后的带宽，单位mb 示例值：320 |
| DiskSize | 是 | Integer | 升配后的磁盘，单位G 示例值：1000 |
| DiskType | 是 | String | 磁盘类型，例如 CLOUD_PREMIUM 示例值：CLOUD_PREMIUM |
| Partition | 是 | Integer | 分区数量 示例值：1200 |
| Topic | 是 | Integer | topic数量 示例值：120 |
| Type | 是 | String | 实例类型例如 sp_ckafka_profession 示例值：sp_ckafka_profession |
| ModifyEntry | 否 | String | 变配入口 示例值：OPEN_ELASTIC_BANDWIDTH_ENTRY |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | DescModifyType | 返回的变配类型结构 示例值：{"ModifyType":1,"MigrateFlag":true,"MigrateCostTime":17066} |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询实例变配类型示例
输入示例
POST / HTTP/1.1
Host: ckafka.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeModifyType
<公共请求参数>
{
"InstanceId": "ckafka-6er88krk",
"BandWidth": 320,
"DiskSize": 1000,
"DiskType": "CLOUD_PREMIUM",
"Partition": 1200,
"Topic": 120,
"Type": "sp_ckafka_profession"
}输出示例
{
"Response": {
"Result": {
"ModifyType": 1,
"MigrateFlag": true,
"MigrateCostTime": 17066
},
"RequestId": "7118b7f95-43de-4d27-8sdadsa-9999999a"
}
}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 | CAM签名/鉴权错误。 |
| DryRunOperation | DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.InstanceNotExist | 实例不存在。 |
| InvalidParameterValue.NotAllowedEmpty | 参数不允许为空。 |
| InvalidParameterValue.RepetitionValue | 已存在相同参数。 |
| InvalidParameterValue.SubnetIdInvalid | 无效的子网id。 |
| InvalidParameterValue.SubnetNotBelongToZone | 子网不属于zone。 |
| InvalidParameterValue.VpcIdInvalid | 无效的 Vpc Id。 |
| InvalidParameterValue.WrongAction | Action参数取值错误。 |
| InvalidParameterValue.ZoneNotSupport | zone不支持。 |
| LimitExceeded | 超过配额限制。 |
| LimitExceeded.RouteOverLimit | 路由数超过限制。 |
| LimitExceeded.RouteSASLOverLimit | SASL路由超过限制。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceInsufficient | 资源不足。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| ResourcesSoldOut | 资源售罄。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |
| UnsupportedOperation.BatchDelInstanceLimit | 批量删除实例限制。 |
| UnsupportedOperation.OssReject | Oss拒绝该操作。 |
