Updated on 2022-10-13 GMT+08:00

Querying Region List

Function

Query the list of regions.

URI

GET /v2/servicerequest/config/regions

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token.

It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Minimum length: 1

Maximum length: 5000

X-Language

No

String

Specifies the language environment. The value is a common language description character string, for example, zh-cn. It is zh-cn by default.

Some internationalization information, such as the service ticket type and name, is displayed based on the language environment.

Minimum length: 1

Maximum length: 32

X-Time-Zone

No

String

Specifies the time zone. The value is a common time zone description character string, for example, GMT+8. It is GMT+8 by default.

Time-related data is processed based on the time zone of the environment.

Minimum length: 1

Maximum length: 32

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

total_count

Integer

Specifies the total number.

Minimum value: 0

Maximum value: 65535

data_center_list

Array of DataCenterV2Do objects

Specifies the region list.

Table 3 DataCenterV2Do

Parameter

Type

Description

type

Integer

Specifies the region type. The options are 0 (China) and 1 (International).

Minimum value: 0

Maximum value: 10

region_id

String

Specifies the region ID.

Minimum length: 1

Maximum length: 64

region_name

String

Specifies the region name.

Minimum length: 1

Maximum length: 64

is_sensitive

Integer

Indicates whether it is sensitive or not.

Minimum value: 0

Maximum value: 1

Request Example

GET https://{endpoint}/v2/servicerequest/config/regions

null

Response Example

Status code: 200

Code 200 is returned if the operation is successful.

{
  "total_count" : 1,
  "data_center_list" : [ {
    "type" : 0,
    "region_id" : "cn-north-1",
    "region_name" : "CN North-Beijng1",
    "is_sensitive" : 1
  } ]
}

Status Codes

Status Code

Description

200

Code 200 is returned if the operation is successful.

Error Codes

See Error Codes.