调用 DescribeRegions 接口查看 Region 列表。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeRegions | 要执行的操作,取值:DescribeRegions。 |
Version | String | 是 | 2022-05-01 | API的版本,取值:2022-05-01。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Regions | Array of Object | -- | 地域列表。 |
POST /?Action=DescribeRegions&Version=2022-05-01 HTTP/1.1 Content-Type: application/json Host: kafka.volcengineapi.com X-Date: 20210328T100802Z Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/Kafka/request, SignedHeaders=x-date, Signature=********
{ "ResponseMetadata": { "RequestId": "2023032021075995F8AAD5096623174D7C", "Action": "DescribeRegions", "Version": "2022-05-01", "Service": "Kafka", "Region": "cn-beijing" }, "Result": { "Regions": [ { "Description": "华东2(上海)", "RegionId": "cn-shanghai", "RegionName": "cn-shanghai", "Status": "Available" }, { "Description": "华北2(北京)", "RegionId": "cn-beijing", "RegionName": "cn-beijing", "Status": "Available" }, { "Description": "华南1(广州)", "RegionId": "cn-guangzhou", "RegionName": "cn-guangzhou", "Status": "Available" } ] } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
---|---|---|
400 | MissingParameter | 缺少%s参数。 |
400 | InvalidParameter | 参数值无效。 |
400 | InvalidParameter.Unsupported | 不支持%s参数。 |
400 | InvalidParameter.Malformed | %s参数不符合规范。 |
400 | Forbidden.Authentication | 账户未实名认证。 |