1. 接口描述
接口请求域名: ckafka.tencentcloudapi.com 。
枚举地域,只支持广州地域
默认接口请求频率限制:100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeRegion。 |
Version | 是 | String | 公共参数,本接口取值:2019-08-19。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Offset | 否 | Integer | 偏移量 示例值:0 |
Limit | 否 | Integer | 返回最大结果数 示例值:50 |
Business | 否 | String | 业务字段,可忽略 示例值:10 |
CdcId | 否 | String | cdc专有集群业务字段,可忽略 示例值:cdc-test |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Result | Array of Region | 返回地域枚举结果列表 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 枚举地域
输入示例
POST / HTTP/1.1
Host: ckafka.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRegion
<公共请求参数>
{
"Business": "10"
}
输出示例
{
"Response": {
"Result": [
{
"RegionId": 8,
"RegionName": "北京",
"AreaName": "华北地区",
"RegionCode": "bj",
"RegionCodeV3": "ap-beijing"
},
{
"RegionId": 16,
"RegionName": "成都",
"AreaName": "西南地区",
"RegionCode": "cd",
"RegionCodeV3": "ap-chengdu"
},
{
"RegionId": 19,
"RegionName": "重庆",
"AreaName": "西南地区",
"RegionCode": "cq",
"RegionCodeV3": "ap-chongqing"
},
{
"RegionId": 5,
"RegionName": "香港",
"AreaName": "东南亚地区",
"RegionCode": "hk",
"RegionCodeV3": "ap-hongkong"
},
{
"RegionId": 9,
"RegionName": "新加坡",
"AreaName": "东南亚地区",
"RegionCode": "sg",
"RegionCodeV3": "ap-singapore"
},
{
"RegionId": 21,
"RegionName": "孟买",
"AreaName": "亚太地区",
"RegionCode": "in",
"RegionCodeV3": "ap-mumbai"
},
{
"RegionId": 25,
"RegionName": "东京",
"AreaName": "亚太地区",
"RegionCode": "jp",
"RegionCodeV3": "ap-tokyo"
},
{
"RegionId": 6,
"RegionName": "多伦多",
"AreaName": "北美地区",
"RegionCode": "ca",
"RegionCodeV3": "na-toronto"
},
{
"RegionId": 15,
"RegionName": "硅谷",
"AreaName": "美国西部",
"RegionCode": "usw",
"RegionCodeV3": "na-siliconvalley"
},
{
"RegionId": 22,
"RegionName": "弗吉尼亚",
"AreaName": "美国东部",
"RegionCode": "use",
"RegionCodeV3": "na-ashburn"
}
],
"RequestId": "fe2ba3b1-90bb-425d-abd4-08a62d0c3686"
}
}
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.BatchDelInstanceLimit | 批量删除实例限制。 |
UnsupportedOperation.OssReject | Oss拒绝该操作。 |