Queries 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.

RegionId String No cn-hangzhou

The ID of the region.

Response parameters

Parameter Type Example Description
RequestId String 611CB80C-B6A9-43DB-9E38-0B0AC3D9B58F

The ID of the request.

Regions Array of Region

The list of regions.

Region
LocalName String China (Hangzhou)

The name of the region.

RegionEndpoint String privatelink.cn-hangzhou.aliyuncs.com

The endpoint of the region.

RegionId String cn-hangzhou

The ID of the region.

Examples

Sample requests

https://[Endpoint]/?Action=DescribeRegions
&<Common request parameters>

Sample success responses

XML format

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

<DescribeRegionsResponse>
    <RequestId>A355E857-97F5-5054-9AC8-BCE064939652</RequestId>
    <Regions>
        <Region>
            <RegionId>cn-hangzhou</RegionId>
            <RegionEndpoint>privatelink.cn-hangzhou.aliyuncs.com</RegionEndpoint>
            <LocalName>China (Hangzhou)</LocalName>
        </Region>
        <Region>
            <RegionId>cn-shanghai</RegionId>
            <RegionEndpoint>privatelink.cn-shanghai.aliyuncs.com</RegionEndpoint>
            <LocalName>China (Shanghai)</LocalName>
        </Region>
        <Region>
            <RegionId>cn-nanjing</RegionId>
            <RegionEndpoint>privatelink.cn-nanjing.aliyuncs.com</RegionEndpoint>
            <LocalName>China (Nanjing - Local Region)</LocalName>
        </Region>
        <Region>
            <RegionId>cn-qingdao</RegionId>
            <RegionEndpoint>privatelink.cn-qingdao.aliyuncs.com</RegionEndpoint>
            <LocalName>China (Qingdao)</LocalName>
        </Region>
        <Region>
            <RegionId>cn-beijing</RegionId>
            <RegionEndpoint>privatelink.cn-beijing.aliyuncs.com</RegionEndpoint>
            <LocalName>China (Beijing)</LocalName>
        </Region>
        <Region>
            <RegionId>cn-zhangjiakou</RegionId>
            <RegionEndpoint>privatelink.cn-zhangjiakou.aliyuncs.com</RegionEndpoint>
            <LocalName>China (Zhangjiakou)</LocalName>
        </Region>
        <Region>
            <RegionId>cn-huhehaote</RegionId>
            <RegionEndpoint>privatelink.cn-huhehaote.aliyuncs.com</RegionEndpoint>
            <LocalName>China (Hohhot)</LocalName>
        </Region>
        <Region>
            <RegionId>cn-wulanchabu</RegionId>
            <RegionEndpoint>privatelink.cn-wulanchabu.aliyuncs.com</RegionEndpoint>
            <LocalName>China (Ulanqab)</LocalName>
        </Region>
        <Region>
            <RegionId>cn-shenzhen</RegionId>
            <RegionEndpoint>privatelink.cn-shenzhen.aliyuncs.com</RegionEndpoint>
            <LocalName>China (Shenzhen)</LocalName>
        </Region>
        <Region>
            <RegionId>cn-heyuan</RegionId>
            <RegionEndpoint>privatelink.cn-heyuan.aliyuncs.com</RegionEndpoint>
            <LocalName>China (Heyuan)</LocalName>
        </Region>
        <Region>
            <RegionId>cn-guangzhou</RegionId>
            <RegionEndpoint>privatelink.cn-guangzhou.aliyuncs.com</RegionEndpoint>
            <LocalName>China (Guangzhou)</LocalName>
        </Region>
        <Region>
            <RegionId>cn-chengdu</RegionId>
            <RegionEndpoint>privatelink.cn-chengdu.aliyuncs.com</RegionEndpoint>
            <LocalName>China (Chengdu)</LocalName>
        </Region>
        <Region>
            <RegionId>cn-hongkong</RegionId>
            <RegionEndpoint>privatelink.cn-hongkong.aliyuncs.com</RegionEndpoint>
            <LocalName>China (Hong Kong)</LocalName>
        </Region>
        <Region>
            <RegionId>ap-southeast-1</RegionId>
            <RegionEndpoint>privatelink.ap-southeast-1.aliyuncs.com</RegionEndpoint>
            <LocalName>Singapore (Singapore)</LocalName>
        </Region>
        <Region>
            <RegionId>ap-southeast-2</RegionId>
            <RegionEndpoint>privatelink.ap-southeast-2.aliyuncs.com</RegionEndpoint>
            <LocalName>Australia (Sydney)</LocalName>
        </Region>
        <Region>
            <RegionId>ap-southeast-3</RegionId>
            <RegionEndpoint>privatelink.ap-southeast-3.aliyuncs.com</RegionEndpoint>
            <LocalName>Malaysia (Kuala Lumpur)</LocalName>
        </Region>
        <Region>
            <RegionId>ap-southeast-5</RegionId>
            <RegionEndpoint>privatelink.ap-southeast-5.aliyuncs.com</RegionEndpoint>
            <LocalName>Indonesia (Jakarta)</LocalName>
        </Region>
        <Region>
            <RegionId>ap-northeast-1</RegionId>
            <RegionEndpoint>privatelink.ap-northeast-1.aliyuncs.com</RegionEndpoint>
            <LocalName>Japan (Tokyo)</LocalName>
        </Region>
        <Region>
            <RegionId>eu-central-1</RegionId>
            <RegionEndpoint>privatelink.eu-central-1.aliyuncs.com</RegionEndpoint>
            <LocalName>Germany (Frankfurt)</LocalName>
        </Region>
        <Region>
            <RegionId>eu-west-1</RegionId>
            <RegionEndpoint>privatelink.eu-west-1.aliyuncs.com</RegionEndpoint>
            <LocalName>UK (London)</LocalName>
        </Region>
        <Region>
            <RegionId>us-west-1</RegionId>
            <RegionEndpoint>privatelink.us-west-1.aliyuncs.com</RegionEndpoint>
            <LocalName>US (Silicon Valley)</LocalName>
        </Region>
        <Region>
            <RegionId>us-east-1</RegionId>
            <RegionEndpoint>privatelink.us-east-1.aliyuncs.com</RegionEndpoint>
            <LocalName>US (Virginia)</LocalName>
        </Region>
        <Region>
            <RegionId>ap-south-1</RegionId>
            <RegionEndpoint>privatelink.ap-south-1.aliyuncs.com</RegionEndpoint>
            <LocalName>India (Mumbai)</LocalName>
        </Region>
    </Regions>
</DescribeRegionsResponse>

JSON format

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

{
  "RequestId" : "A355E857-97F5-5054-9AC8-BCE064939652",
  "Regions" : {
    "Region" : [ {
      "RegionId" : "cn-hangzhou",
      "RegionEndpoint" : "privatelink.cn-hangzhou.aliyuncs.com",
      "LocalName":"China (Hangzhou)",
    }, {
      "RegionId" : "cn-shanghai",
      "RegionEndpoint" : "privatelink.cn-shanghai.aliyuncs.com",
      "LocalName": "China (Shanghai)"
    }, {
      "RegionId" : "cn-nanjing",
      "RegionEndpoint" : "privatelink.cn-nanjing.aliyuncs.com",
      "LocalName" : "China (Nanjing - Local Region)"
    }, {
      "RegionId" : "cn-qingdao",
      "RegionEndpoint" : "privatelink.cn-qingdao.aliyuncs.com",
      "LocalName": "China (Qingdao)"
    }, {
      "RegionId" : "cn-beijing",
      "RegionEndpoint" : "privatelink.cn-beijing.aliyuncs.com",
      "LocalName": "China (Beijing)"
    }, {
      "RegionId" : "cn-zhangjiakou",
      "RegionEndpoint" : "privatelink.cn-zhangjiakou.aliyuncs.com",
      "LocalName": "China (Zhangjiakou)"
    }, {
      "RegionId" : "cn-huhehaote",
      "RegionEndpoint" : "privatelink.cn-huhehaote.aliyuncs.com",
      "LocalName": "China (Hohhot)"
    }, {
      "RegionId" : "cn-wulanchabu",
      "RegionEndpoint" : "privatelink.cn-wulanchabu.aliyuncs.com",
      "LocalName": "China (Ulanqab)"
    }, {
      "RegionId" : "cn-shenzhen",
      "RegionEndpoint" : "privatelink.cn-shenzhen.aliyuncs.com",
      "LocalName": "China (Shenzhen)"
    }, {
      "RegionId" : "cn-heyuan",
      "RegionEndpoint" : "privatelink.cn-heyuan.aliyuncs.com",
      "LocalName" : "China (Heyuan)"
    }, {
      "RegionId" : "cn-guangzhou",
      "RegionEndpoint" : "privatelink.cn-guangzhou.aliyuncs.com",
      "LocalName": "China (Guangzhou)"
    }, {
      "RegionId" : "cn-chengdu",
      "RegionEndpoint" : "privatelink.cn-chengdu.aliyuncs.com",
      "LocalName": "China (Chengdu)"
    }, {
      "RegionId" : "cn-hongkong",
      "RegionEndpoint" : "privatelink.cn-hongkong.aliyuncs.com",
      "LocalName": "China (Hong Kong)"
    }, {
      "RegionId" : "ap-southeast-1",
      "RegionEndpoint" : "privatelink.ap-southeast-1.aliyuncs.com",
      "LocalName": "Singapore (Singapore)"
    }, {
      "RegionId" : "ap-southeast-2",
      "RegionEndpoint" : "privatelink.ap-southeast-2.aliyuncs.com",
      "LocalName": "Australia (Sydney)"
    }, {
      "RegionId" : "ap-southeast-3",
      "RegionEndpoint" : "privatelink.ap-southeast-3.aliyuncs.com",
      "LocalName": "Malaysia (Kuala Lumpur)"
    }, {
      "RegionId" : "ap-southeast-5",
      "RegionEndpoint" : "privatelink.ap-southeast-5.aliyuncs.com",
      "LocalName": "Indonesia (Jakarta)"
    }, {
      "RegionId" : "ap-northeast-1",
      "RegionEndpoint" : "privatelink.ap-northeast-1.aliyuncs.com",
      "LocalName": "Japan (Tokyo)"
    }, {
      "RegionId" : "eu-central-1",
      "RegionEndpoint" : "privatelink.eu-central-1.aliyuncs.com",
      "LocalName": "Germany (Frankfurt)"
    }, {
      "RegionId" : "eu-west-1",
      "RegionEndpoint" : "privatelink.eu-west-1.aliyuncs.com",
      "LocalName": "UK (London)"
    }, {
      "RegionId" : "us-west-1",
      "RegionEndpoint" : "privatelink.us-west-1.aliyuncs.com",
      "LocalName" : "US (Silicon Valley)"
    }, {
      "RegionId" : "us-east-1",
      "RegionEndpoint" : "privatelink.us-east-1.aliyuncs.com",
      "LocalName" : "US (Virginia)"
    }, {
      "RegionId" : "ap-south-1",
      "RegionEndpoint" : "privatelink.ap-south-1.aliyuncs.com",
      "LocalName": "India (Mumbai)"
    } ]
  }
}

Error codes

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