List regions (GET /v3/regions{?parent_region_id})

Lists regions.

Request headers

Content-type

Indicates the format of content defined in the MIME specification.

Specify application/json. (required)

Data type Cardinality
xsd:string 1..1

Accept

Indicates the accept format defined in the MIME specification.

Specify application/json. (optional)

Data type Cardinality
xsd:string 1..1

X-Auth-Token

Valid authentication token

Data type Cardinality
xsd:string 1..1

Request parameters

parent_region_id

Parent region ID

Data type Cardinality Parent element Child element
xsd:string 0..1 None None

Response headers

HTTP status code

Returns the HTTP status code of the request.

One of the following values will be returned.

200:
Normal completion
400:
Invalid access (invalid parameter, etc.)
401:
Authentication error
403:
Cannot access (no privileges)
404:
No applicable resources
409:
Data conflict occurred
500:
Unexpected error
501:
Has not been implemented
503:
Cannot use service
Data type Cardinality
int 1..1

Vary

By setting or changing the following header, notification is given that expressions can be requested in a different file format.

X-Auth-Token

Data type Cardinality
xsd:string 1..1

Content-Type

Indicates the format of content defined in the MIME specification.

application/json

Data type Cardinality
xsd:string 1..1

Content-Length

Indicates the length of an entity in bytes.

Data type Cardinality
int 1..1

Date

Indicates the date when the request was created.

Data type Cardinality
date 1..1

Response elements

regions

regions object

Data type Cardinality Parent element Child element
Element 1..1 None (region)

(region)

region object (object name is not displayed)

Data type Cardinality Parent element Child element
Element 0..n None parent_region_id

id

links

description

parent_region_id

Parent region ID

Data type Cardinality Parent element Child element
xsd:string 0..1 (region) None

id

Region ID

Data type Cardinality Parent element Child element
xsd:string 0..1 (region) None

links

Link information of region

Data type Cardinality Parent element Child element
Element 0..1 (region) self

description

Description of region

Data type Cardinality Parent element Child element
xsd:string 0..1 (region) None

links

API link information

Data type Cardinality Parent element Child element
Element 0..1 None self

previous

next

Example of request


GET /v3/regions
X-Auth-Token: MIIIHgYJKoZIhvcNAQcCoIIIDzCCCAsCAQExC . . .

Example of response


HTTP/1.1 200 OK
Vary: X-Auth-Token
Content-Type: application/json
Content-Length: 412
Date: Mon, 01 Sep 2014 23:49:00 GMT

{
    "regions": [
        {
            "description": "jp-east-1 region",
            "id": "jp-east-1",
            "links": {
                "self": "https://identity.jp-east-1.cloud.global.fujitsu.com/v3/regions/jp-east-1",
            },
            "parent_region_id": null
        },
        {
            "description": "jp-east-1a AZ",
            "id": "jp-east-1a",
            "links": {
                "self": "https://identity.jp-east-1.cloud.global.fujitsu.com/v3/regions/jp-east-1a",
            },
            "parent_region_id": "jp-east-1"
        }
    ],
    "links": {
        "self": "https://identity.jp-east-1.cloud.global.fujitsu.com/v3/regions",
        "previous": null,
        "next": null
    }
}