Queries available 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 headers

This operation does not have operation-specific request headers and uses only common request headers. For more information, see Common request parameters and common response parameters.

Request syntax

GET /pop/v1/paas/regionConfig HTTP/1.1

Request parameters

No request parameters are required.

Response parameters

ParameterTypeExampleDescription
MessageStringsuccess

The returned information.

RequestIdStringDDE85827-B0B3-4E56-86E8-17C42009****

The ID of the request.

RegionsArray of Region

The list of regions.

Region
LocalNameStringChina (Hong Kong)

The name of the region. Valid values:

  • China (Hong Kong)
  • Singapore
  • Indonesia (Jakarta)
  • Japan (Tokyo)
RegionEndpointStringsae.cn-hongkong.aliyuncs.com

The endpoint of the region. Valid values:

  • sae.cn-hongkong.aliyuncs.com
  • sae.ap-southeast-1.aliyuncs.com
  • sae.ap-southeast-5.aliyuncs.com
  • sae.ap-northeast-1.aliyuncs.com
RegionIdStringcn-hongkong

The ID of the region. Valid values:

  • cn-hongkong: the ID of the China (Hong Kong) region
  • ap-southeast-1: the ID of the Singapore region
  • ap-southeast-5: the ID of the Indonesia (Jakarta) region
  • ap-northeast-1: the ID of the Japan (Tokyo) region
RecommendZonesArray of Stringcn-hongkong-b

The recommended zones. Recommended zones have relatively sufficient resources in each region. Format:

  • If a region contains recommended zones, this parameter is returned in the "RecommendZone": ["cn-hongkong-b", "cn-hongkong-d", "cn-hongkong-c"] format.
  • If a region does not contain recommended zones, this parameter is returned in the "RecommendZone": [] format.
CodeInteger200

The HTTP status code. Valid values:

  • 2xx: The call was successful.
  • 3xx: The call was redirected.
  • 4xx: The call failed.
  • 5xx: A server error occurred.

Examples

Sample requests

GET /pop/v1/paas/regionConfig HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json

Sample success responses

XML format

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

<DescribeRegionsResponse>
    <Message>success</Message>
    <RequestId>DDE85827-B0B3-4E56-86E8-17C42009****</RequestId>
    <Regions>
        <LocalName>China (Hong Kong)</LocalName>
        <RegionEndpoint>sae.cn-hongkong.aliyuncs.com</RegionEndpoint>
        <RegionId>cn-hongkong</RegionId>
        <RecommendZones>cn-hongkong-b</RecommendZones>
    </Regions>
    <Code>200</Code>
</DescribeRegionsResponse>

JSON format

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

{
  "Message" : "success",
  "RequestId" : "DDE85827-B0B3-4E56-86E8-17C42009****",
  "Regions" : [ {
    "LocalName" : "China (Hong Kong)"
    "RegionEndpoint" : "sae.cn-hongkong.aliyuncs.com",
    "RegionId" : "cn-hongkong",
    "RecommendZones" : [ "cn-hongkong-b" ]
  } ],
  "Code" : 200
}

Error codes

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