Help Center/ Config/ API Reference/ APIs/ Region Management/ Querying Available Regions

Updated on 2025-12-15 GMT+08:00

View PDF

Querying Available Regions

Function

This API is used to query regions visible to you.

Calling Method

For details, see Calling APIs.

URI

GET /v1/resource-manager/domains/{domain_id}/regions

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Specifies the account ID. Maximum: 36

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Specifies the maximum number of records to return. Minimum: 1 Maximum: 200 Default: 200
marker	No	String	Specifies the pagination parameter. You can use the marker value in a subsequent call to request the next set of list items. Minimum: 4 Maximum: 400

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Language	No	String	Specifies the language of the information to return. The default name is zh-cn, which can be zh-cn and en-us. Default: zh-cn
X-Auth-Token	No	String	Specifies the invoker's token.
X-Security-Token	No	String	Specifies a temporary security credential. This parameter is mandatory when you make an API call using a temporary security credential.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
value	Array of Region objects	Specifies the list of region information.
page_info	PageInfo object	Specifies the pagination object.

**Table 5** Region
Parameter	Type	Description
region_id	String	Specifies the region ID.
display_name	String	Specifies the display name.

**Table 6** PageInfo
Parameter	Type	Description
current_count	Integer	Specifies the resource quantity on the current page. Minimum: 0 Maximum: 200
next_marker	String	Specifies the marker value of the next page. Minimum: 4 Maximum: 400

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Example Requests

None

Example Responses

Status code: 200

Operation succeeded.

{
  "value" : [ {
    "region_id" : "regionid1",
    "display_name" : "region1"
  }, {
    "region_id" : "regionid2",
    "display_name" : "region2"
  } ],
  "page_info" : {
    "current_count" : 2,
    "next_marker" : null
  }
}