Queries the list of available Alibaba Cloud regions.

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.

PageSize Integer No 10

The number of entries to return on each page.

Valid values: 1 to 100.

Default value: 10.

PageNumber Integer No 1

The number of the page to return.

Minimum value: 1. Default value: 1.

FileSystemType String No standard

The type of the file system.

Default value: standard. Valid values:

  • standard: General-purpose NAS file system
  • extreme: Extreme NAS file system
  • cpfs: CPFS file system

Response parameters

Parameter Type Example Description
TotalCount Integer 1

The total number of regions.

RequestId String A70BEE5D-76D3-49FB-B58F-1F398211****

The ID of the request.

PageSize Integer 10

The number of entries returned per page.

PageNumber Integer 1

The page number of the returned page.

Regions Array of Region

The array of regions.

Region
LocalName String East China 1

The name of the region.

RegionEndpoint String nas.cn-hangzhou.aliyuncs.com

The endpoint of the region.

RegionId String cn-hangzhou

The ID of the region.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeRegions
&PageSize=10
&PageNumber=1
&FileSystemType=standard
&Common request parameters

Sample responses

XML format

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

<TotalCount>1</TotalCount>
<PageSize>10</PageSize>
<RequestId>A70BEE5D-76D3-49FB-B58F-1F398211****</RequestId>
<PageNumber>1</PageNumber>
<Regions>
    <Region>
        <RegionId>cn-hangzhou</RegionId>
        <RegionEndpoint>nas.cn-hangzhou.aliyuncs.com</RegionEndpoint>
        <LocalName>East China 1</LocalName>
    </Region>
</Regions>

JSON format

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

{
  "TotalCount" : 1,
  "PageSize" : 10,
  "RequestId" : "A70BEE5D-76D3-49FB-B58F-1F398211****",
  "PageNumber" : 1,
  "Regions" : {
    "Region" : {
      "RegionId" : "cn-hangzhou",
      "RegionEndpoint" : "nas.cn-hangzhou.aliyuncs.com",
      "LocalName" : "East China 1"
    }
  }
}

Error codes

For a list of error codes, visit the API Error Center.