You need to enable JavaScript to run this app.
文档中心
消息队列 Kafka版

消息队列 Kafka版

复制全文
下载 pdf
资源检查
DescribeRegions - 查看地域列表
复制全文
下载 pdf
DescribeRegions - 查看地域列表
调用 DescribeRegions 接口查看 Region 列表。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:DescribeRegions​
要执行的操作,取值:DescribeRegions。​
​
Version string 必选 示例值:2022-05-01​
API的版本,取值:2022-05-01。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
Regions object[] 示例值:--​
地域列表。​
RegionId string 示例值:cn-shanghai​
Region ID。​
​
Description string 示例值:华东2(上海)​
Region 的描述信息。​
​
Status string 示例值:Available​
Region 的状态。​
  • Available:启用。用户可在此地域下进行查看、新建资源等动作。​
  • Unavailable:停用。​
​
RegionName string 示例值:cn-shanghai​
Region 名称。​
​
​
​
​
请求示例​
​
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​
The request body is missing a required parameter %s.​
缺少%s参数。​
400​
InvalidParameter​
The specified parameter is not valid.​
参数值无效。​
400​
InvalidParameter.Unsupported​
The specified parameter %s is not supported.​
不支持%s参数。​
400​
InvalidParameter.Malformed​
The specified parameter %s is Malformed.​
%s参数不符合规范。​
400​
Forbidden.Authentication​
This operation is forbidden by Realname Authentication system.​
账户未实名认证。​
​
​
最近更新时间:2025.08.08 17:47:27
这个页面对您有帮助吗?
有用
有用
无用
无用