Querying Region Details

Function

This API is used to query region details.

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/{region_id}

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
region_id	Yes	String	ID of the region to be queried. You can obtain a region ID by using the API described in Querying a Region List or using the console.

Request Parameters

**Table 2** Parameters in the request header
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).

Response Parameters

**Table 3** Parameters in the response body
Parameter	Type	Description
region	Object	Region information.

**Table 4** region
Parameter	Type	Description
description	String	Description of the region.
parent_region_id	String	An embedded field, which has no specific meanings. The value null is returned.
links	Object	Region resource link.
locales	Object	Region name. Not all fields in the object are returned, which is determined by the registered region.
id	String	Region ID.
type	String	Region type.

**Table 5** region.links
Parameter	Type	Description
self	String	Resource link.

**Table 6** region.locales
Parameter	Type	Description
en-us	String	Region name in English.
pt-br	String	Region name in Portuguese.
es-us	String	Region name in American Spanish.
es-es	String	Region name in Spanish.

Example Request

Request for querying region details

GET https://iam.myhuaweicloud.com/v3/regions/{region_id}

Example Response

Status code: 200

The request is successful.

{
    "region": {
        "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": "",
            "en-us": "LA-Santiago",
            "es-us": "AL-Santiago de Chile1",
            "es-es": "LA-Santiago"
        }
    }
}

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.