Querying Regions Visible to You¶

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 tags. Maximum: 36

Request Parameters¶

**Table 2** Request header parameters¶
Parameter	Mandatory	Type	Description
X-Language	No	String	Language of the returned message. Default: en-us
X-Auth-Token	No	String	Specifies the invoker's token.
X-Security-Token	No	String	Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

Response Parameters¶

Status code: 200

**Table 3** Response body parameters¶
Parameter	Type	Description
value	Array of Region objects	Specifies the list of region information.

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

Status code: 400

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

Status code: 403

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

Status code: 404

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

Status code: 500

**Table 8** 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"
  } ]
}

Status Codes¶

Status Code	Description
200	Operation succeeded.
400	Invalid parameters.
403	User authentication failed.
404	User not found.
500	Server error.

Error Codes¶

See Error Codes.

last updated: 2024-11-13 14:00 UTC - commit: eb1f267ba56b00f5029ba8a8e402b01b07baad13