Querying Region Details

Function

This API is used to query region details.

URI

  • URI format

    GET /v3/regions/{region_id}

  • URI parameters

    Parameter

    Mandatory

    Type

    Description

    region_id

    Yes

    String

    Region ID.

Request Parameters

  • 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

    Authenticated token.

  • Example request

    curl -i -k -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -H "X-Auth-Token:$token" -X GET https://sample.domain.com/v3/regions/test-pusb999999991
    

Response Parameters

Example response

{
    "region": {
        "parent_region_id": null,
        "description": "",
        "links": {
            "self": "https://sample.domain.com/v3/regions/test-pusb999999991"
        },
        "type": "public",
        "id": "test-pusb999999991",
        "locales": {
            "en-us": "region_name"
        }
    }
}

Status Codes

Status Code

Description

200

The request is successful.

400

The server failed to process the request.

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.