1. 接口描述
接口请求域名： ckafka.tencentcloudapi.com 。
用于查看ckafka的可用区列表
默认接口请求频率限制：100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeCkafkaZone。 |
| Version | 是 | String | 公共参数，本接口取值：2019-08-19。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| CdcId | 否 | String | cdc集群Id 示例值：cluster-test |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | ZoneResponse | 查询结果复杂对象实体 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查看可用区列表
输入示例
POST / HTTP/1.1
Host: ckafka.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCkafkaZone
<公共请求参数>
{}输出示例
{
"Response": {
"RequestId": "65192154-338c-4cd4-b3c0-1457dfdd2e4c",
"Result": {
"ClusterInfo": [],
"ForceCheckTag": null,
"Limit": null,
"MaxBandwidth": 1200,
"MaxBuyInstanceNum": 20,
"MessagePrice": {
"RealTotalCost": 0,
"TotalCost": 0
},
"Offset": null,
"Physical": "",
"Profession": "{\"BasicEdition\":{\"Bandwidth\":{\"Maximum\":1200,\"Minimal\":20,\"Step\":20},\"DiskCapacity\":{\"20\":{\"Maximum\":500000,\"Minimal\":200,\"Step\":100},\"40\":{\"Maximum\":500000,\"Minimal\":500,\"Step\":100},\"120\":{\"Maximum\":500000,\"Minimal\":1000,\"Step\":100},\"320\":{\"Maximum\":500000,\"Minimal\":3000,\"Step\":100},\"800\":{\"Maximum\":500000,\"Minimal\":5400,\"Step\":100},\"1000\":{\"Maximum\":500000,\"Minimal\":7500,\"Step\":100}},\"DiskTypes\":[\"SSD\",\"CLOUD_BASIC\"],\"MessageRetention\":{\"Maximum\":2160,\"Minimal\":24,\"Step\":1},\"Partition\":{\"20\":{\"Maximum\":40000,\"Minimal\":400,\"Step\":100},\"40\":{\"Maximum\":40000,\"Minimal\":800,\"Step\":100},\"60\":{\"Maximum\":40000,\"Minimal\":900,\"Step\":100},\"120\":{\"Maximum\":40000,\"Minimal\":1200,\"Step\":100},\"180\":{\"Maximum\":40000,\"Minimal\":1400,\"Step\":100},\"240\":{\"Maximum\":40000,\"Minimal\":1600,\"Step\":100},\"320\":{\"Maximum\":40000,\"Minimal\":1800,\"Step\":100},\"400\":{\"Maximum\":40000,\"Minimal\":2000,\"Step\":100},\"500\":{\"Maximum\":40000,\"Minimal\":2200,\"Step\":100},\"600\":{\"Maximum\":40000,\"Minimal\":2400,\"Step\":100},\"800\":{\"Maximum\":40000,\"Minimal\":2600,\"Step\":100},\"1000\":{\"Maximum\":40000,\"Minimal\":2800,\"Step\":100},\"1200\":{\"Maximum\":40000,\"Minimal\":3200,\"Step\":100}}},\"HighPerformanceEdition\":{\"Bandwidth\":{\"Maximum\":100000,\"Minimal\":1600,\"Step\":200},\"DiskCapacity\":{\"1600\":{\"Maximum\":500000,\"Minimal\":10000,\"Step\":100},\"2000\":{\"Maximum\":500000,\"Minimal\":10000,\"Step\":100},\"2400\":{\"Maximum\":500000,\"Minimal\":10000,\"Step\":100},\"2800\":{\"Maximum\":500000,\"Minimal\":10000,\"Step\":100},\"3200\":{\"Maximum\":500000,\"Minimal\":10000,\"Step\":100}},\"DiskTypes\":[\"SSD\",\"CLOUD_BASIC\"],\"MessageRetention\":{\"Maximum\":2160,\"Minimal\":24,\"Step\":1},\"Partition\":{\"1600\":{\"Maximum\":40000,\"Minimal\":4000,\"Step\":100},\"2000\":{\"Maximum\":40000,\"Minimal\":4500,\"Step\":100},\"2400\":{\"Maximum\":40000,\"Minimal\":5000,\"Step\":100},\"2800\":{\"Maximum\":40000,\"Minimal\":5500,\"Step\":100},\"3200\":{\"Maximum\":40000,\"Minimal\":6000,\"Step\":100}}}}\n",
"PublicNetwork": "[{\"Maximum\":198,\"Minimal\":3,\"step\":3}]",
"PublicNetworkLimit": "{\"Maximum\":999,\"Minimal\":198,\"step\":3,\"minimalZoneIds\":[100001,100002,200001,300001,400001],\"unsupportedRegionId\":[32,78]}",
"RequestId": null,
"Standard": "",
"StandardS2": "{\"InstanceTypeConfigSet\":[{\"Type\":\"sv_ckafka_instance_s2_1\",\"Desc\":\"入门型\",\"DescEn\":\"Small\",\"Bandwidth\":320,\"MinDiskSize\":300,\"MaxDiskSize\":1000,\"DiskSize\":500,\"Pid\":1004034,\"MaximumInstancePartition\":60,\"MaximumInstanceTopic\":25},{\"Type\":\"sv_ckafka_instance_s2_2\",\"Desc\":\"标准型\",\"DescEn\":\"Standard\",\"Bandwidth\":800,\"DiskSize\":1500,\"MinDiskSize\":500,\"MaxDiskSize\":2500,\"Pid\":1004037,\"MaximumInstancePartition\":100,\"MaximumInstanceTopic\":40},{\"Type\":\"sv_ckafka_instance_s2_3\",\"Desc\":\"进阶型\",\"DescEn\":\"Advanced\",\"Bandwidth\":1200,\"DiskSize\":3000,\"MinDiskSize\":1000,\"MaxDiskSize\":4000,\"Pid\":1004038,\"MaximumInstancePartition\":150,\"MaximumInstanceTopic\":50}],\"maximumTopicPartition\":2500,\"maximumInstanceConsumerGroup\":0}",
"UnitPrice": {
"RealTotalCost": 0,
"TotalCost": 0
},
"Version": null,
"ZoneList": [
{
"AppId": 1300957330,
"ExtraFlag": "1",
"Flag": true,
"IsInternalApp": 1,
"SalesInfo": [
{
"Flag": true,
"Platform": "standard",
"SoldOut": true,
"Version": "0.10.2.1"
},
{
"Flag": true,
"Platform": "standard",
"SoldOut": true,
"Version": "1.1.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": true,
"Version": "0.10.2"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": true,
"Version": "1.1.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": true,
"Version": "2.4.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": true,
"Version": "2.8.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": true,
"Version": "3.2.3"
},
{
"Flag": false,
"Platform": "premium",
"SoldOut": true,
"Version": "2.4.1"
},
{
"Flag": false,
"Platform": "premium",
"SoldOut": true,
"Version": "2.8.1"
},
{
"Flag": false,
"Platform": "premium",
"SoldOut": true,
"Version": "3.2.3"
}
],
"SoldOut": "true",
"ZoneId": "800001",
"ZoneName": "北京一区",
"ZoneStatus": 4
},
{
"AppId": 1300957330,
"ExtraFlag": "0",
"Flag": false,
"IsInternalApp": 1,
"SalesInfo": [
{
"Flag": false,
"Platform": "standard",
"SoldOut": true,
"Version": "0.10.2.1"
},
{
"Flag": false,
"Platform": "standard",
"SoldOut": true,
"Version": "1.1.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": true,
"Version": "0.10.2"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": true,
"Version": "1.1.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": true,
"Version": "2.4.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": true,
"Version": "2.8.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": true,
"Version": "3.2.3"
},
{
"Flag": false,
"Platform": "premium",
"SoldOut": true,
"Version": "2.4.1"
},
{
"Flag": false,
"Platform": "premium",
"SoldOut": true,
"Version": "2.8.1"
},
{
"Flag": false,
"Platform": "premium",
"SoldOut": true,
"Version": "3.2.3"
}
],
"SoldOut": "true",
"ZoneId": "800002",
"ZoneName": "北京二区",
"ZoneStatus": 3
},
{
"AppId": 1300957330,
"ExtraFlag": "0",
"Flag": false,
"IsInternalApp": 1,
"SalesInfo": [
{
"Flag": false,
"Platform": "standard",
"SoldOut": false,
"Version": "0.10.2.1"
},
{
"Flag": false,
"Platform": "standard",
"SoldOut": true,
"Version": "1.1.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": false,
"Version": "0.10.2"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": false,
"Version": "1.1.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": false,
"Version": "2.4.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": false,
"Version": "2.8.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": false,
"Version": "3.2.3"
},
{
"Flag": false,
"Platform": "premium",
"SoldOut": false,
"Version": "2.4.1"
},
{
"Flag": false,
"Platform": "premium",
"SoldOut": false,
"Version": "2.8.1"
},
{
"Flag": false,
"Platform": "premium",
"SoldOut": false,
"Version": "3.2.3"
}
],
"SoldOut": "false",
"ZoneId": "800003",
"ZoneName": "北京三区",
"ZoneStatus": 3
},
{
"AppId": 1300957330,
"ExtraFlag": "0",
"Flag": false,
"IsInternalApp": 1,
"SalesInfo": [
{
"Flag": false,
"Platform": "standard",
"SoldOut": false,
"Version": "0.10.2.1"
},
{
"Flag": false,
"Platform": "standard",
"SoldOut": false,
"Version": "1.1.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": true,
"Version": "0.10.2"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": true,
"Version": "1.1.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": true,
"Version": "2.4.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": true,
"Version": "2.8.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": true,
"Version": "3.2.3"
},
{
"Flag": false,
"Platform": "premium",
"SoldOut": true,
"Version": "2.4.1"
},
{
"Flag": false,
"Platform": "premium",
"SoldOut": true,
"Version": "2.8.1"
},
{
"Flag": false,
"Platform": "premium",
"SoldOut": true,
"Version": "3.2.3"
}
],
"SoldOut": "true",
"ZoneId": "800004",
"ZoneName": "北京四区",
"ZoneStatus": 3
},
{
"AppId": 1300957330,
"ExtraFlag": "0",
"Flag": false,
"IsInternalApp": 1,
"SalesInfo": [
{
"Flag": false,
"Platform": "standard",
"SoldOut": false,
"Version": "0.10.2.1"
},
{
"Flag": false,
"Platform": "standard",
"SoldOut": false,
"Version": "1.1.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": true,
"Version": "0.10.2"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": true,
"Version": "1.1.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": true,
"Version": "2.4.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": true,
"Version": "2.8.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": true,
"Version": "3.2.3"
},
{
"Flag": false,
"Platform": "premium",
"SoldOut": true,
"Version": "2.4.1"
},
{
"Flag": false,
"Platform": "premium",
"SoldOut": true,
"Version": "2.8.1"
},
{
"Flag": false,
"Platform": "premium",
"SoldOut": true,
"Version": "3.2.3"
}
],
"SoldOut": "true",
"ZoneId": "800005",
"ZoneName": "北京五区",
"ZoneStatus": 3
},
{
"AppId": 1300957330,
"ExtraFlag": "0",
"Flag": false,
"IsInternalApp": 1,
"SalesInfo": [
{
"Flag": false,
"Platform": "standard",
"SoldOut": false,
"Version": "0.10.2.1"
},
{
"Flag": false,
"Platform": "standard",
"SoldOut": false,
"Version": "1.1.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": false,
"Version": "0.10.2"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": false,
"Version": "1.1.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": false,
"Version": "2.4.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": false,
"Version": "2.8.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": false,
"Version": "3.2.3"
},
{
"Flag": false,
"Platform": "premium",
"SoldOut": false,
"Version": "2.4.1"
},
{
"Flag": false,
"Platform": "premium",
"SoldOut": false,
"Version": "2.8.1"
},
{
"Flag": false,
"Platform": "premium",
"SoldOut": false,
"Version": "3.2.3"
}
],
"SoldOut": "false",
"ZoneId": "800006",
"ZoneName": "北京六区",
"ZoneStatus": 3
},
{
"AppId": 1300957330,
"ExtraFlag": "0",
"Flag": false,
"IsInternalApp": 1,
"SalesInfo": [
{
"Flag": false,
"Platform": "standard",
"SoldOut": false,
"Version": "0.10.2.1"
},
{
"Flag": false,
"Platform": "standard",
"SoldOut": false,
"Version": "1.1.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": false,
"Version": "0.10.2"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": false,
"Version": "1.1.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": false,
"Version": "2.4.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": false,
"Version": "2.8.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": false,
"Version": "3.2.3"
},
{
"Flag": false,
"Platform": "premium",
"SoldOut": false,
"Version": "2.4.1"
},
{
"Flag": false,
"Platform": "premium",
"SoldOut": false,
"Version": "2.8.1"
},
{
"Flag": false,
"Platform": "premium",
"SoldOut": false,
"Version": "3.2.3"
}
],
"SoldOut": "false",
"ZoneId": "800007",
"ZoneName": "北京七区",
"ZoneStatus": 3
},
{
"AppId": 1300957330,
"ExtraFlag": "1",
"Flag": true,
"IsInternalApp": 1,
"SalesInfo": [
{
"Flag": true,
"Platform": "standard",
"SoldOut": true,
"Version": "0.10.2.1"
},
{
"Flag": true,
"Platform": "standard",
"SoldOut": true,
"Version": "1.1.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": false,
"Version": "0.10.2"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": false,
"Version": "1.1.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": false,
"Version": "2.4.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": false,
"Version": "2.8.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": false,
"Version": "3.2.3"
},
{
"Flag": false,
"Platform": "premium",
"SoldOut": false,
"Version": "2.4.1"
},
{
"Flag": false,
"Platform": "premium",
"SoldOut": false,
"Version": "2.8.1"
},
{
"Flag": false,
"Platform": "premium",
"SoldOut": false,
"Version": "3.2.3"
}
],
"SoldOut": "false",
"ZoneId": "2000800004",
"ZoneName": "腾讯地图CDZ北京一区",
"ZoneStatus": 4
},
{
"AppId": 1300957330,
"ExtraFlag": "0",
"Flag": false,
"IsInternalApp": 1,
"SalesInfo": [
{
"Flag": false,
"Platform": "standard",
"SoldOut": true,
"Version": "0.10.2.1"
},
{
"Flag": false,
"Platform": "standard",
"SoldOut": true,
"Version": "1.1.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": false,
"Version": "0.10.2"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": false,
"Version": "1.1.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": false,
"Version": "2.4.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": false,
"Version": "2.8.1"
},
{
"Flag": false,
"Platform": "profession",
"SoldOut": false,
"Version": "3.2.3"
},
{
"Flag": false,
"Platform": "premium",
"SoldOut": false,
"Version": "2.4.1"
},
{
"Flag": false,
"Platform": "premium",
"SoldOut": false,
"Version": "2.8.1"
},
{
"Flag": false,
"Platform": "premium",
"SoldOut": false,
"Version": "3.2.3"
}
],
"SoldOut": "false",
"ZoneId": "800008",
"ZoneName": "北京八区",
"ZoneStatus": 3
}
]
}
}
}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 | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue.InstanceNotExist | 实例不存在。 |
| InvalidParameterValue.RepetitionValue | 已存在相同参数。 |
| InvalidParameterValue.SubnetIdInvalid | 无效的子网id。 |
| InvalidParameterValue.SubnetNotBelongToZone | 子网不属于zone。 |
| InvalidParameterValue.VpcIdInvalid | 无效的 Vpc Id。 |
| InvalidParameterValue.WrongAction | Action参数取值错误。 |
| InvalidParameterValue.ZoneNotSupport | zone不支持。 |
| ResourceUnavailable | 资源不可用。 |
| UnauthorizedOperation | 未授权操作。 |
| UnsupportedOperation | 操作不支持。 |
| UnsupportedOperation.BatchDelInstanceLimit | 批量删除实例限制。 |
| UnsupportedOperation.OssReject | Oss拒绝该操作。 |
