Updated on 2023-12-06 GMT+08:00

Querying Regions

Function

This API is used to query regions.

Calling Method

For details, see Calling APIs.

URI

GET /v1/regions

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token. The token can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

regions

Array of Region objects

Specifies the regions.

request_id

String

Specifies the request ID.

Table 3 Region

Parameter

Type

Description

region_id

String

Specifies the region ID.

area

String

Specifies the acceleration area. The value can be one of the following:

  • OUTOFCM: Outside the Chinese mainland

  • CM: Chinese mainland

supported_endpoint_types

Array of strings

Specifies the endpoint type supported by the region. The value can be EIP.

Enumeration values:

  • EIP

Example Requests

Querying regions

GET https://{ga_endpoint}/v1/regions

Example Responses

Status code: 200

Operation succeeded.

{
  "regions" : [ {
    "region_id" : "ap-southeast-1",
    "area" : "OUTOFCM",
    "supported_endpoint_types" : [ "EIP" ]
  } ],
  "request_id" : "ac1bf54f-6a23-4074-af77-800648d25bc8"
}

Status Codes

Status Code

Description

200

Operation succeeded.

Error Codes

See Error Codes.