DescribeRegions - 查询地域列表--云服务器-火山引擎

文档中心

立即注册

导航

云服务器

DescribeRegions - 查询地域列表

最近更新时间：2024.05.21 10:23:57首次发布时间：2023.07.07 10:22:31

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeRegions	要执行的操作，取值：DescribeRegions。
Version	String	是	2020-04-01	API的版本，取值：2020-04-01。
MaxResults	Integer	否	10	分页查询时设置的每页行数。最大值：20 最小值：1 默认值：10
NextToken	String	否	--	分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的`NextToken`参数值。
RegionIds.N	Array of String	否	RegionIds.1=cn-beijing	地域ID，最多支持20个ID。参数 - N：表示地域ID的序号。多个RegionId之间用&分隔。

返回参数

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

参数	类型	示例值	描述
NextToken	String	bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******	本次调用返回的查询凭证值，返回为空表示该页为末页。
Regions	Array of RegionsForDescribeRegions	--	符合条件的地域信息。

请求示例

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"
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidArgument	The specified argument is invalid.	指定的参数不合法。
400	LimitExceeded.MaximumRegionIds	The number of specified RegionIds exceeds the maximum limit.	指定的RegionIds超过最大限制。
429	FlowLimitExceeded	You've reach the limit on request rate of resources.	您已超过资源请求限速。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。