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专业集群业务参数 |
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": {
"Result": {
"ZoneList": [
{
"ZoneId": "300001",
"IsInternalApp": 2,
"AppId": 1255613487,
"Flag": true,
"ZoneName": "香港一区",
"ZoneStatus": 4,
"Exflag": "1",
"SoldOut": "false",
"SalesInfo": [
{
"Platform": "xx",
"Flag": true,
"Version": "xx",
"SoldOut": true
}
]
},
{
"ZoneId": "300002",
"IsInternalApp": 2,
"AppId": 1255613487,
"Flag": false,
"ZoneName": "香港二区",
"ZoneStatus": 4,
"Exflag": "1",
"SoldOut": "false",
"SalesInfo": [
{
"Platform": "xx",
"Flag": true,
"Version": "xx",
"SoldOut": true
}
]
},
{
"ZoneId": "300003",
"IsInternalApp": 2,
"AppId": 1255613487,
"Flag": false,
"ZoneName": "香港三区",
"ZoneStatus": 4,
"Exflag": "1",
"SalesInfo": [
{
"Platform": "xx",
"Flag": true,
"Version": "xx",
"SoldOut": true
}
],
"SoldOut": "true"
}
],
"MaxBuyInstanceNum": 20,
"MaxBandwidth": 1200,
"UnitPrice": {
"RealTotalCost": 2.376,
"TotalCost": 0
},
"MessagePrice": {
"RealTotalCost": 0.18,
"TotalCost": 0
},
"ClusterInfo": [],
"Standard": "{}",
"StandardS2": "{\"InstanceTypeConfigSet\":[{\"Type\":\"sv_ckafka_instance_s2_1\",\"Desc\":\"入门型\",\"Bandwidth\":320,\"DiskSize\":500,\"Pid\":15127,\"MaximumInstancePartition\":100,\"MaximumInstanceTopic\":40},{\"Type\":\"sv_ckafka_instance_s2_2\",\"Desc\":\"标准型\",\"Bandwidth\":800,\"DiskSize\":1500,\"Pid\":15128,\"MaximumInstancePartition\":160,\"MaximumInstanceTopic\":80},{\"Type\":\"sv_ckafka_instance_s2_3\",\"Desc\":\"进阶型\",\"Bandwidth\":1200,\"DiskSize\":3000,\"Pid\":15129,\"MaximumInstancePartition\":200,\"MaximumInstanceTopic\":100},{\"Type\":\"sv_ckafka_instance_s2_4\",\"Desc\":\"容量型\",\"Bandwidth\":1600,\"DiskSize\":4500,\"Pid\":15130,\"MaximumInstancePartition\":300,\"MaximumInstanceTopic\":150},{\"Type\":\"sv_ckafka_instance_s2_5\",\"Desc\":\"高阶型1\",\"Bandwidth\":2400,\"DiskSize\":6000,\"Pid\":15131,\"MaximumInstancePartition\":500,\"MaximumInstanceTopic\":250},{\"Type\":\"sv_ckafka_instance_s2_6\",\"Desc\":\"高阶型2\",\"Bandwidth\":3200,\"DiskSize\":8000,\"Pid\":15132,\"MaximumInstancePartition\":600,\"MaximumInstanceTopic\":300},{\"Type\":\"sv_ckafka_instance_s2_7\",\"Desc\":\"高阶型3\",\"Bandwidth\":4800,\"DiskSize\":10000,\"Pid\":15133,\"MaximumInstancePartition\":800,\"MaximumInstanceTopic\":400},{\"Type\":\"sv_ckafka_instance_s2_8\",\"Desc\":\"高阶型4\",\"Bandwidth\":7200,\"DiskSize\":12000,\"Pid\":15134,\"MaximumInstancePartition\":1000,\"MaximumInstanceTopic\":500}],\"maximumTopicPartition\":1000,\"maximumInstanceConsumerGroup\":0}\n",
"Profession": "{\"BasicEdition\":{\"Bandwidth\":{\"Maximum\":1200,\"Minimal\":40,\"Step\":20},\"DiskCapacity\":{\"40\":{\"Maximum\":5000,\"Minimal\":500,\"Step\":100},\"120\":{\"Maximum\":10000,\"Minimal\":1000,\"Step\":100},\"320\":{\"Maximum\":30000,\"Minimal\":3000,\"Step\":100},\"620\":{\"Maximum\":54000,\"Minimal\":5400,\"Step\":100},\"920\":{\"Maximum\":75000,\"Minimal\":7500,\"Step\":100}},\"DiskTypes\":[\"SSD\",\"CLOUD_BASIC\"],\"MessageRetention\":{\"Maximum\":2160,\"Minimal\":24,\"Step\":1},\"Partition\":{\"40\":{\"Maximum\":1000,\"Minimal\":500,\"Step\":100},\"60\":{\"Maximum\":1200,\"Minimal\":600,\"Step\":100},\"120\":{\"Maximum\":1600,\"Minimal\":800,\"Step\":100},\"180\":{\"Maximum\":2000,\"Minimal\":1000,\"Step\":100},\"240\":{\"Maximum\":2400,\"Minimal\":1200,\"Step\":100},\"320\":{\"Maximum\":2800,\"Minimal\":1400,\"Step\":100},\"400\":{\"Maximum\":3200,\"Minimal\":1600,\"Step\":100},\"500\":{\"Maximum\":3600,\"Minimal\":1800,\"Step\":100},\"600\":{\"Maximum\":4000,\"Minimal\":2000,\"Step\":100},\"800\":{\"Maximum\":4500,\"Minimal\":2400,\"Step\":100},\"1000\":{\"Maximum\":5000,\"Minimal\":2800,\"Step\":100},\"1200\":{\"Maximum\":5500,\"Minimal\":3200,\"Step\":100}},\"Topic\":{\"40\":{\"Maximum\":100,\"Minimal\":50,\"Step\":1},\"60\":{\"Maximum\":120,\"Minimal\":60,\"Step\":1},\"120\":{\"Maximum\":160,\"Minimal\":80,\"Step\":1},\"180\":{\"Maximum\":200,\"Minimal\":100,\"Step\":1},\"240\":{\"Maximum\":240,\"Minimal\":120,\"Step\":1},\"320\":{\"Maximum\":280,\"Minimal\":160,\"Step\":1},\"400\":{\"Maximum\":320,\"Minimal\":200,\"Step\":1},\"500\":{\"Maximum\":360,\"Minimal\":240,\"Step\":1},\"600\":{\"Maximum\":400,\"Minimal\":280,\"Step\":1},\"800\":{\"Maximum\":450,\"Minimal\":320,\"Step\":1},\"1000\":{\"Maximum\":500,\"Minimal\":360,\"Step\":1},\"1200\":{\"Maximum\":550,\"Minimal\":400,\"Step\":1}}},\"HighPerformanceEdition\":{\"Bandwidth\":{\"Maximum\":3200,\"Minimal\":1600,\"Step\":400},\"DiskCapacity\":{\"1600\":{\"Maximum\":120000,\"Minimal\":12000,\"Step\":100},\"2000\":{\"Maximum\":160000,\"Minimal\":16000,\"Step\":100},\"2400\":{\"Maximum\":200000,\"Minimal\":20000,\"Step\":100},\"2800\":{\"Maximum\":240000,\"Minimal\":24000,\"Step\":100},\"3200\":{\"Maximum\":280000,\"Minimal\":28000,\"Step\":100}},\"DiskTypes\":[\"SSD\",\"CLOUD_BASIC\"],\"MessageRetention\":{\"Maximum\":2160,\"Minimal\":24,\"Step\":1},\"Partition\":{\"1600\":{\"Maximum\":6000,\"Minimal\":4000,\"Step\":100},\"2000\":{\"Maximum\":7000,\"Minimal\":4500,\"Step\":100},\"2400\":{\"Maximum\":8000,\"Minimal\":5000,\"Step\":100},\"2800\":{\"Maximum\":9000,\"Minimal\":5500,\"Step\":100},\"3200\":{\"Maximum\":10000,\"Minimal\":6000,\"Step\":100}},\"Topic\":{\"1600\":{\"Maximum\":600,\"Minimal\":500,\"Step\":1},\"2000\":{\"Maximum\":700,\"Minimal\":600,\"Step\":1},\"2400\":{\"Maximum\":800,\"Minimal\":700,\"Step\":1},\"2800\":{\"Maximum\":900,\"Minimal\":800,\"Step\":1},\"3200\":{\"Maximum\":1000,\"Minimal\":900,\"Step\":1}}}}",
"Physical": "{}",
"PublicNetwork": "{}",
"PublicNetworkLimit": "{}"
},
"RequestId": "4831a936-0a03-408e-9ffc-a813a11ad769"
}
}
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拒绝该操作。 |