DescribeCkafkaZone
Last updated: 2025-11-21 20:32:34
DescribeCkafkaZone
Last updated: 2025-11-21 20:32:34
1. API Description
Domain name for API request: ckafka.intl.tencentcloudapi.com.
This API is used to view the AZ list of Ckafka.
A maximum of 100 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeCkafkaZone. |
| Version | Yes | String | Common Params. The value used for this API: 2019-08-19. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| CdcId | No | String | cdc cluster Id. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Result | ZoneResponse | Returned results for the query |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 View Available Zone List
Input Example
POST / HTTP/1.1
Host: ckafka.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCkafkaZone
<Common request parameters>
{}Output Example
{
"Response": {
"RequestId": "65192154-338c-4cd4-b3c0-1457dfdd2e4c",
"Result": {
"ClusterInfo": [],
"MaxBandwidth": 1200,
"MaxBuyInstanceNum": 20,
"MessagePrice": {
"RealTotalCost": 0,
"TotalCost": 0
},
"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]}",
"Standard": "",
"StandardS2": "{\"InstanceTypeConfigSet\":[{\"Type\":\"sv_ckafka_instance_s2_1\",\"Desc\":\"entry-level\",\"DescEn\":\"Small\",\"Bandwidth\":320,\"MinDiskSize\":300,\"MaxDiskSize\":1000,\"DiskSize\":500,\"Pid\":1004034,\"MaximumInstancePartition\":60,\"MaximumInstanceTopic\":25},{\"Type\":\"sv_ckafka_instance_s2_2\",\"Desc\":\"standard type\",\"DescEn\":\"Standard\",\"Bandwidth\":800,\"DiskSize\":1500,\"MinDiskSize\":500,\"MaxDiskSize\":2500,\"Pid\":1004037,\"MaximumInstancePartition\":100,\"MaximumInstanceTopic\":40},{\"Type\":\"sv_ckafka_instance_s2_3\",\"Desc\":\"advanced\",\"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
},
"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": "Beijing Zone 1",
"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": "Beijing Zone 2",
"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": "Beijing Zone 3"
"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": "Beijing Zone 4"
"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": "Beijing Zone 5"
"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": "Beijing Zone 6"
"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": "Beijing Zone 7",
"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": "Tencent Maps CDZ Beijing Zone 1"
"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": "Beijing Zone 8"
"ZoneStatus": 3
}
]
}
}
}5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InvalidParameter | Invalid parameter. |
| InvalidParameterValue.InstanceNotExist | The instance does not exist. |
| InvalidParameterValue.RepetitionValue | The parameter already exists. |
| InvalidParameterValue.SubnetIdInvalid | Invalid subnet ID. |
| InvalidParameterValue.SubnetNotBelongToZone | The subnet is not in the zone. |
| InvalidParameterValue.VpcIdInvalid | Invalid VPC ID. |
| InvalidParameterValue.WrongAction | The value of the Action parameter is incorrect. |
| InvalidParameterValue.ZoneNotSupport | The zone is not supported. |
| ResourceUnavailable | The resource is unavailable. |
| UnauthorizedOperation | Unauthorized operation. |
| UnsupportedOperation | Unsupported operation. |
| UnsupportedOperation.BatchDelInstanceLimit | The batch instance deletion limit is reached. |
| UnsupportedOperation.OssReject | Oss rejected the operation. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No
Feedback