Querying Regions
Function
This API is used to query the regions accessible to a specified user.
The API can be called using both the global endpoint and region-specific endpoints. For IAM endpoints, see Regions and Endpoints.
Debugging
You can debug this API in API Explorer.
URI
GET /v3/regions
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Content-Type |
Yes |
String |
Fill application/json;charset=utf8 in this field. |
X-Auth-Token |
Yes |
String |
IAM user token (no special permission requirements). If the token does not contain private region information, no private regions will be returned. |
Response Parameters
Parameter |
Type |
Description |
---|---|---|
Object |
Resource link information. |
|
Array of objects |
Region information. |
Parameter |
Type |
Description |
---|---|---|
self |
String |
Resource link. |
previous |
String |
Previous resource link. |
next |
String |
Next resource link. |
Example Request
Request for querying a region list
GET https://iam.myhuaweicloud.com/v3/regions
Example Response
Status code: 200
The request is successful.
{ "regions": [ { "parent_region_id": null, "description": "", "links": { "self": "https://iam.myhuaweicloud.com/v3/regions/ap-southeast-1" }, "type": "public", "id": "ap-southeast-1", "locales": { "zh-cn": "CN-Hong Kong", "en-us": "ap-southeast-1" } }, { "parent_region_id": null, "description": "", "links": { "self": "https://iam.myhuaweicloud.com/v3/regions/la-south-2" }, "type": "public", "id": "la-south-2", "locales": { "pt-br": "AL-Santiago", "zh-cn": "Region name in Chinese", "en-us": "LA-Santiago", "es-us": "AL-Santiago de Chile1", "es-es": "LA-Santiago" } } ], "links": { "self": "https://iam.myhuaweicloud.com/v3/regions", "previous": null, "next": null } }
Status Codes
Status Code |
Description |
---|---|
200 |
The request is successful. |
400 |
Invalid parameters. |
401 |
Authentication failed. |
403 |
Access denied. |
404 |
The requested resource cannot be found. |
405 |
The method specified in the request is not allowed for the requested resource. |
413 |
The request entity is too large. |
500 |
Internal server error. |
503 |
Service unavailable. |
Error Codes
None
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot