Show AvailabilityZone

Overview

This page describes operations you can perform on availability_zone. availability_zone indicate location of VMs.

Classification

  • Show

API Operation Object

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{api_endpoint}/v2/{tenant_id}/os-availability-zone

HTTP Request Header

Accept: application/json
Content-Type: application/json
X-Auth-Token: <token>

HTTP Request Body

  • none

Request Parameter

Input Parameters
name style format description required/optional default value action for invalid parameter response code for invalid parameter
tenant_id URL UUID ID for the tenant. required - Terminate 403, 404
token Header Authentication token string Keystone authentication token. required - Terminate 401

Response

HTTP Response Header

Format

HTTP/1.1 200 OK
  • <response_code>: see “HTTP Responses” section
  • <message>: message based on the response code

HTTP Response Code

Response Codes
response code condition
200 normal end
400 specified parameter is invalid
401 unauthorized
403 tenant is not available
405 request URL or method is invalid
500 compute fault

Response Body

Format

{
  "availabilityZoneInfo": [
    {
      "zoneName": "<zoneName>",
      "hosts": "<hosts>",
      "zoneState": "<zoneState>"
    }
  ]
}

Response Parameter

Response Parameters
item format   description
availabilityZoneInfo AvailabilityZoneInfo   AvailabilityZone Information including zoneName, hosts, zoneState.

Sample Request and Response

Sample API Request

Request URI

https://baremetal-server-jp1-ecl.api.ntt.com/v2/b322a85578de48beba0f92acce57869b/os-availability-zone

Request Header

GET /v2/b322a85578de48beba0f92acce57869b/os-availability-zone HTTP/1.1
User-Agent: curl/7.35.0
Host: 192.168.150.51:8774
Accept: application/json
Content-Type: application/json
X-Auth-Token: 62d528dc0cca4827b0ed465efe1c2588

Sample API Response

Response Header

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: <content-length>
Date: Thu, 17 Jul 2014 04:21:06 GMT

Response Body

{
  "availabilityZoneInfo": [
    {
      "zoneName": "zone1-groupa",
      "hosts": null,
      "zoneState": {
        "available": true
      }
    }
  ]
}