You need to enable JavaScript to run this app.
导航
云服务器
  • 文档首页
    • /
  • 云服务器

DescribeRegions

最近更新时间：2023.11.20 10:48:37

首次发布时间：2023.07.07 10:22:31

我的收藏

调用 DescribeRegions 接口查询地域信息。

调试

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

请求参数

名称类型是否必填示例值描述
ActionString是DescribeRegions要执行的操作，取值：DescribeRegions。
VersionString是2020-04-01API的版本，取值：2020-04-01。

RegionIds.N

String

否

RegionIds.1=cn-beijing

地域ID，最多支持20个ID。

  • 参数 - N：表示地域ID的序号。

  • 多个ID之间用&分隔。

NextTokenString否-分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的NextToken参数值。

MaxResults

Integer

否

-

分页查询时设置的每页行数。

  • 默认值：10

  • 最大值：20

返回数据

名称
类型
示例值
描述
Regions
Array of Struct
-
地域信息。
NextToken
String
bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******
本次调用返回的查询凭证值，返回为空表示该页为末页。

错误码

HttpCode错误码错误信息描述
400InvalidArgumentThe specified argument is invalid.指定的参数不合法。
400LimitExceeded.MaximumRegionIdsThe number of specified RegionIds exceeds the maximum limit.指定的RegionIds超过最大限制。
429FlowLimitExceededYou've reach the limit on request rate of resources.您已超过资源请求限速。
500InternalErrorAn internal error has occurred.内部错误，请重试。如果多次尝试失败，请提交工单。

请求示例

GET /?Action=DescribeRegions&Version=2020-04-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202106111445100102252431000052****",
        "Action": "DescribeRegions",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "NextToken": "eWJwMHd3MzE2dmVwMjkyMnk******",
        "Regions": [
            {
                "RegionId": "cn-beijing"
            }
        ]
    }
}