Updated on 2023-08-02 GMT+08:00

Querying All Supported Regions

Function

This API is used to query all supported regions.

URI

GET /v1/apm2/openapi/region/get-all-supported-region

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token obtained from IAM.

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

region_list

Array of Region objects

Region list

Table 3 Region

Parameter

Type

Description

region_id

String

Region ID.

region_name

String

Region name.

region

String

Region.

project_id

String

Enterprise project ID.

status

String

Region status.

Example Requests

There is no input parameter. Send a request to query supported regions.

/v1/apm2/openapi/region/get-all-supported-region

Example Responses

Status code: 200

OK: The request is successful.

{
  "region_list" : [ {
    "region_id" : "xx-xxxx-xx",
    "region_name" : "xxxx",
    "region" : "xx-xxxx-xx",
    "project_id" : null,
    "status" : null
  }, {
    "region_id" : "mock-region",
    "region_name" : "xxxx mock",
    "region" : "mock-region",
    "project_id" : null,
    "status" : null
  } ]
}

Status Codes

Status Code

Description

200

OK: The request is successful.

401

Unauthorized: No permissions.

403

Forbidden: Access forbidden.

404

Not Found: The requested resource is not found.

Error Codes

See Error Codes.