Help Center/ IAM Identity Center/ API Reference/ API/ Instance Management/ Querying the Region Where a Service Instance Is Enabled
Updated on 2025-08-21 GMT+08:00
View PDF
Share

Querying the Region Where a Service Instance Is Enabled

Function

This API is used to query the region where an IAM Identity Center instance is enabled. It can be called only from the organization's management account or from a delegated administrator account of a cloud service.

URI

GET /v1/registered-regions

Request Parameters

Table 1 Parameters in the request header

Parameter

Mandatory

Type

Description

X-Security-Token

No

String

Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required.

Response Parameters

Status code: 200

Table 2 Parameters in the response body

Parameter

Type

Description

regions

Array of RegionDto objects

Site list.
Table 3 RegionDto

Parameter

Type

Description

region_id

String

Region ID.

Status code: 400

Table 4 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Unique ID of a request.

Status code: 403

Table 5 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Unique ID of a request.

encoded_authorization_message

String

Encrypted error message.

Status code: 404

Table 6 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Unique ID of a request.

Example Request

Querying the region where an IAM Identity Center service instance is enabled

GET https://{hostname}/v1/registered-regions

Example Response

Status code: 200

Successful

{
  "regions" : [ {
    "region_id" : "cn-north-4"
  } ]
}

Status Codes

Status Code

Description

200

Successful.

400

Bad request.

403

Forbidden.

404

Not found.

Error Codes

For details, see Error Codes.

Parent topic: Instance Management