DescribeRegions - 查询Region--消息队列 RocketMQ版-火山引擎

文档中心

立即注册

导航

DescribeRegions - 查询Region

最近更新时间：2024.11.18 10:27:30首次发布时间：2023.07.12 16:22:33

调用 DescribeRegions 接口查看 Region 列表。

注意事项

请求频率：该接口请求频率限制为 100 次/秒；单用户请求频率限制为 20 次/秒。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeRegions	要执行的操作，取值：DescribeRegions。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Regions	Array of Object	/	地域列表。

请求示例

POST /?Action=DescribeRegions&Version=2023-01-01 HTTP/1.1
Content-Type: application/json
Host: rocketmq.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-shanghai/rocketmq/request, SignedHeaders=x-date, Signature=********

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023032021075995F8AAD5096623174D7C",
        "Action": "DescribeRegions",
        "Version": "2023-01-01",
        "Service": "RocketMQ",
        "Region": "cn-nantong"
    },
    "Result": {
        "Regions": [
            {
                "Description": "华东2（上海）",
                "RegionId": "cn-shanghai",
                "RegionName": "cn-shanghai",
                "Status": "Available"
            },
            {
                "Description": "华北2（北京）",
                "RegionId": "cn-shanghai",
                "RegionName": "cn-shanghai",
                "Status": "Available"
            },
            {
                "Description": "华南1（广州）",
                "RegionId": "cn-guangzhou",
                "RegionName": "cn-guangzhou",
                "Status": "Available"
            }
        ]
    }
}

错误码

公共错误码请参见公共错误码文档。