List Availability Zones (Detail)

Overview

Lists available availability zones detail

Classification

  • List

API Operation Object

  • AvailabilityZone

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{api_endpoint}/v1.0/{tenant_id}/availability_zone/detail

HTTP Request Header

Format

X-Auth-Token: <token>

HTTP Request Body

Format

  • none

Request Parameter

  • none

Response

HTTP Response Header

Response Code

Response Codes
Code Description Error? Note
200 OK No  
400 Bad Request Yes  
401 Unauthorized Yes  
500 Internal Server Error Yes  

HTTP Response Body

Response Parameter

Response Parameters
Key Value
api_error_message Error Message
availabilityZoneInfo List of AvailabilityZone objects
zoneState zoneState object
available true or false
zoneName Name of the zone consists of 'zonename-groupname'

Sample API Request and Response

Sample API Request

curl -s -i -X GET https://storage-jp1.ecl.api.ntt.com/v1.0/7dea34ac34a14d04b0accbfe793c74af/availability_zone/detail -H 'Content-type: application/json' -H 'Accept: application/json' -H 'X-Auth-Token: bd0343af86a74e5cb9867a69729675ba'

Sample API Response

HTTP/1.1 200 OK
Date: Thu, 21 Apr 2016 05:26:05 GMT
Content-Type: application/json
Content-Length: 239
Connection: keep-alive
Set-Cookie: TS0183560f=01cce65ce1f4efb39c7a6a5f67ccf6529ebb7618621090a8719e76769ba05d355c04ef7674; Path=/

{
  "api_error_message": "",
  "availabilityZoneInfo": [
    {
      "zoneState": {
        "available": true
      },
      "zoneName": "zone1-groupa"
    },
    {
      "zoneState": {
        "available": true
      },
      "zoneName": "zone1-groupb"
    }
  ]
}