All Products
Search
Document Center

:DescribeRegions

Last Updated:Aug 01, 2024

Queries available regions.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
sae:DescribeRegionsget
  • All Resources
    *
    none
none

Request syntax

GET /pop/v1/paas/regionConfig

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
object
Messagestring

No request parameters are required.

success
RequestIdstring

The returned information.

DDE85827-B0B3-4E56-86E8-17C42009****
Regionsarray<object>

The ID of the request.

object
LocalNamestring

The list of regions.

RegionEndpointstring

The name of the region. Valid values:

  • China (Hangzhou)
  • China (Shanghai)
  • China (Beijing)
  • China (Zhangjiakou)
  • China (Shenzhen)
  • China (Guangzhou)
  • China (Hong Kong)
  • Singapore (Singapore)
  • US (Silicon Valley)
sae.cn-shanghai.aliyuncs.com
RegionIdstring

The endpoint of the region. Valid values:

  • sae.cn-hangzhou.aliyuncs.com
  • sae.cn-shanghai.aliyuncs.com
  • sae.cn-beijing.aliyuncs.com
  • sae.cn-zhangjiakou.aliyuncs.com
  • sae.cn-shenzhen.aliyuncs.com
  • sae.cn-guangzhou.aliyuncs.com
  • sae.cn-hongkong.aliyuncs.com
  • sae.ap-southeast-1.aliyuncs.com
  • sae.us-west-1.aliyuncs.com
cn-shanghai
RecommendZonesarray

The ID of the region. Valid values:

  • cn-hangzhou: the ID of the China (Hangzhou) region
  • cn-shanghai: the ID of the China (Shanghai) region
  • cn-beijing: the ID of the China (Beijing) region
  • cn-zhangjiakou: the ID of the China (Zhangjiakou) region
  • cn-shenzhen: the ID of the China (Shenzhen) region
  • cn-guangzhou: the ID of the China (Guangzhou) region
  • cn-hongkong: the ID of the China (Hong Kong) region
  • ap-southeast-1: the ID of the Singapore region
  • us-west-1: the ID of the US (Silicon Valley) region
string
cn-hongkong-b
Codeinteger

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

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2021-11-25The response structure of the API has changedView Change Details