Querying a Region List

Function

This API is used to query a region list.

URI

GET /v3/regions

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. If the token does not contain the private region information, the system does not return the private region in the query result.

• 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

Response Parameters

• Parameters in the response body

  Parameter	Mandatory	Type	Description
  links	Yes	Dict	Region resource link.
  regions	Yes	List	Region list.

• Description for the regions format

  Parameter	Mandatory	Type	Description
  description	Yes	String	Region description.
  parent_region_id	Yes	String	Parent region ID of a region.
  id	Yes	String	Region ID.
  locales	Yes	Dict	Region name.
  type	No	String	Region type.
  links	Yes	Dict	Region resource link.

• Example response (successful response)

  {
      "regions": [
          {
              "parent_region_id": null,
              "description": "",
              "links": {
                  "self": "None/v3/regions/1500365963661574434"
              },
              "type": "private",
              "id": "1500365963661574434",
              "locales": {
                 
                  "en-us": "region_name2"
              }
          },
          {
              "parent_region_id": null,
              "description": "",
              "links": {
                  "self": "https://sample.domain.com/v3/regions/500017826026667755"
              },
              "type": "private",
              "id": "500017826026667755",
              "locales": {
               
                  "en-us": "region_name2"
              }
          },
          {
              "parent_region_id": null,
              "description": "",
              "links": {
                  "self": "https://sample.domain.com/v3/regions/region_name"
              },
              "type": "public",
              "id": "test2",
              "locales": {
                  
                  "en-us": "region_name2"
              }
          },
          {
              "parent_region_id": null,
              "links": {
                  "self": "https://sample.domain.com/v3/regions/test1112244"
              },
              "id": "test1112244",
              "locales": {
                  
                  "en-us": "testregion1"
              },
              "description": ""
          }
      ],
      "links": {
          "self": "https://sample.domain.com/v3/regions",
          "previous": null,
          "next": null
      }
  }

Status Codes