DescribeRegions

更新时间: 2023-09-13 18:24:37

调用DescribeRegions查询您可以使用的阿里云地域。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称

类型

是否必选

示例值

描述

Action String DescribeRegions

系统规定参数。取值:DescribeRegions

InstanceChargeType String PrePaid

实例的计费方式,更多信息,请参见计费概述。取值范围:

  • PrePaid:包年包月。此时,您必须确认自己的账号支持余额支付或者信用支付,否则将报错InvalidPayMethod。
  • PostPaid:按量付费。

默认值:PostPaid。

ResourceType String instance

资源类型。取值范围:

  • instance:ECS实例。
  • disk:磁盘。
  • reservedinstance:预留实例券。
  • scu:存储容量单位包。

默认值:instance。

AcceptLanguage String zh-CN

根据汉语、英语和日语筛选返回结果。更多详情,请参见RFC 7231。取值范围:

  • zh-CN:中文。
  • en-US:英文。
  • ja:日文。

默认值:zh-CN。

返回数据

名称

类型

示例值

描述

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

Regions Array of Region

地域信息集合。

Region
Status String available

集群是否售罄。可能值:

  • available。
  • soldOut。
RegionEndpoint String ecs.aliyuncs.com

地域对应的接入地址(Endpoint)。

LocalName String 华北1(青岛)

地域名称。

RegionId String cn-qingdao-et2-bo1

地域ID。

示例

请求示例

https://ecs.aliyuncs.com/?Action=DescribeRegions
&RegionId=cn-qingdao
&InstanceChargeType=PrePaid
&ResourceType=Instance
&AcceptLanguage=en-US
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeRegionsResponse>
    <RequestId>38EC7366-F5A9-46B1-BDB1-0FDC2E296397</RequestId>
    <Regions>
        <Region>
            <RegionId>cn-qingdao-et2-b01</RegionId>
            <RegionEndpoint>ecs.aliyuncs.com</RegionEndpoint>
            <LocalName>华北1(青岛)</LocalName>
        </Region>
        <Region>
            <RegionId>cn-qingdao-nebula</RegionId>
            <RegionEndpoint>ecs.cn-qingdao-nebula.aliyuncs.com</RegionEndpoint>
            <LocalName>cn-qingdao-nebula</LocalName>
        </Region>
    </Regions>
</DescribeRegionsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "38EC7366-F5A9-46B1-BDB1-0FDC2E296397",
  "Regions" : {
    "Region" : [ {
      "RegionId" : "cn-qingdao-et2-b01",
      "RegionEndpoint" : "ecs.aliyuncs.com",
      "LocalName" : "华北1(青岛)"
    }, {
      "RegionId" : "cn-qingdao-nebula",
      "RegionEndpoint" : "ecs.cn-qingdao-nebula.aliyuncs.com",
      "LocalName" : "cn-qingdao-nebula"
    } ]
  }
}

错误码

HttpCode

错误码

错误信息

描述

403 Unauthorized.EmptyRegion The specified account has no access authority to any region. 当前账号未被授权访问任何地域,请您授权后再重试。
404 InvalidAcceptLanguage.NotFound Only Chinese (zh-CN), English (en-US), and Japanese (ja) are allowed. 您选择的语言类型无效,现在只支持中文、英语和日语。
404 InvalidResourceType.NotFound The ResourceType provided does not exist in our records. 指定的资源类型不存在。

访问错误中心查看更多错误码。

阿里云首页 云服务器 ECS 相关技术圈