Queries the region list.

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

ParameterTypeRequiredExampleDescription
ActionStringYesDescribeRegions

The operation that you want to perform. Set the value to DescribeRegions.

AcceptLanguageStringNozh-CN

The supported languages. Valid values:

  • zh-CN: Chinese.
  • en-US: English.
  • ja:Japanese.
LangStringNoen

The language.

UserClientIpStringNo192.0.2.0

The IP address of the client.

Response parameters

ParameterTypeExampleDescription
RegionsArray

The list of regions.

Region

The information about a region.

LocalNameStringChina North 2 (Beijing)

The Chinese name of the region.

RegionEndpointStringpvtz.aliyuncs.com

The endpoint of Alibaba Cloud DNS PrivateZone in the region.

RegionIdStringcn-shenzhen 

The ID of the region.

RegionNameStringChina South 1

The name of the region.

RequestIdStringAF7D4DCE-0776-47F2-A9B2-6FB85A87AA60

The ID of the request.

Examples

Sample requests


http://pvtz.aliyuncs.com/?Action=DescribeRegions
&<Common request parameters>

Sample success responses

XML format

<DescribeRegionsResponse>
    <RequestId>AF7D4DCE-0776-47F2-A9B2-6FB85A87AA60</RequestId>
    <Regions>
        <Region>
            <RegionName>China North 2</RegionName>
            <RegionId>cn-beijing</RegionId>
        </Region>
        <Region>
            <RegionName>China South 1</RegionName>
            <RegionId>cn-shenzhen</RegionId>
        </Region>
    </Regions>
</DescribeRegionsResponse>

JSON format

{
	"RequestId":"8043FAEA-4E1B-4349-AEBF-9D0FCCE5AE2F"
	"Regions":{
		"Region":[
			{
				"RegionName":"China North 2"
				"RegionId":"cn-beijing"
			},
			{
				"RegionName":"China South 1"
				" RegionId":"cn-shenzhen"
			}
		]
	}
}

Error codes

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