DescribeRegions - - Alibaba Cloud ドキュメントセンター

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeRegions	The operation that you want to perform. Set the value to DescribeRegions.
InstanceChargeType	String	No	PrePaid	The billing method of the instance. For more information, see Billing overview. Valid values: PrePaid: subscription. If you set this parameter to PrePaid, make sure that you have sufficient balance or credits in your account. Otherwise, the InvalidPayMethod error code is returned. PostPaid: pay-as-you-go. Default value: PostPaid.
ResourceType	String	No	instance	The resource type. Valid values: instance: Elastic Compute Service (ECS) instance. disk: disk reservedinstance: reserved instance scu: storage capacity unit (SCU) Default value: instance.
AcceptLanguage	String	No	zh-CN	The natural language that is used to filter responses. For more information, see RFC 7231. Valid values: zh-CN: Chinese en-US: English ja: Japanese Default value: zh-CN.

Response parameters

Parameter	Type	Example	Description
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	The ID of the request.
Regions	Array of Region		Details about the regions.
Region
Status	String	available	Indicates whether clusters are sold out. Valid values: available soldOut
RegionEndpoint	String	ecs.aliyuncs.com	The endpoint for the region.
LocalName	String	China (Qingdao)	The name of the region.
RegionId	String	cn-qingdao-et2-bo1	The region ID.

Examples

Sample requests

https://ecs.aliyuncs.com/?Action=DescribeRegions
&RegionId=cn-qingdao
&InstanceChargeType=PrePaid
&ResourceType=Instance
&AcceptLanguage=en-US
&<Common request parameters>

Sample success responses

XML format

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>China (Qingdao)</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 format

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" : "China (Qingdao)"
    }, {
      "RegionId" : "cn-qingdao-nebula",
      "RegionEndpoint" : "ecs.cn-qingdao-nebula.aliyuncs.com",
      "LocalName" : "cn-qingdao-nebula"
    } ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	Unauthorized.EmptyRegion	The specified account has no access authority to any region.	You do not have the permissions to access regions. Apply for the required permissions and try again.
404	InvalidAcceptLanguage.NotFound	Only Chinese (zh-CN), English (en-US), and Japanese (ja) are allowed.	The selected language is not supported. Only Chinese, English, and Japanese are supported.
404	InvalidResourceType.NotFound	The ResourceType provided does not exist in our records.	The specified resource type is not found.

For a list of error codes, see Service error codes.