List Servers Details

Overview

This API lists your Dedicated Hypervisor servers information in detail.

Classification

  • List

API Operation Object

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

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

HTTP Request Header

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

HTTP Request Body

Format

  • 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
changes-since query dateTime A time/date stamp for when the server last changed status. optional - Terminate 400
marker query UUID UUID of the server at which you want to set a marker. Find servers from the next UUID of the given one. optional - Terminate 400
limit query int Integer value for the limit of values to return. optional - Terminate 400
name query String Name of the Dedicated Hypervisor server as a string optional - Terminate 400
image query URI Name of the image in URL format. This parameter can be obtained by GET /images API. optional - Terminate 400
flavor query URI Name of the flavor in URL format. This parameter can be obtained by GET /flavors API. optional - Terminate 400, 404
status query String Value of the status of the server so that you can filter on. optional - Terminate 400

Response

HTTP Response Header

Format

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

Response Code

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

HTTP Response Body

Format

{
  "servers": "<servers>"
}

Response Parameter

Response Parameters
item format   description
servers Server Array   List of servers
next anyURI   Moves to the next item.
previous anyURI   Moves to the previous item.

Sample Request and Response

Sample API Request

Request URI

https://dedicated-hypervisor-jp1-ecl.api.ntt.com/v1.0/b322a85578de48beba0f92acce57869b/servers/detail?limit=10

HTTP Request Header

PUT /v1.0/b322a85578de48beba0f92acce57869b/servers/detail?limit=10
User-Agent: curl/7.35.0
Host: 192.168.150.51:8774
Content-Type: application/json
Accept: application/json
X-Auth-Token: 62d528dc0cca4827b0ed465efe1c2588

Sample API Response

HTTP Response Header

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

HTTP Response Body

{
  "servers": [
    {
      "id": "eabfac89-59d1-4e25-88d6-513ec0aa3e32",
      "name": "server-1",
      "imageRef": "eabfac89-59d1-4e25-88d6-513ec0aa3e34",
      "description": "hogehoge",
      "status": "ACTIVE",
      "hypervisor_type": "vsphere_esxi",
      "baremetal_server": {
        "OS-EXT-STS:power_state": "RUNNING",
        "OS-EXT-STS:task_state": "None",
        "OS-EXT-STS:vm_state": "ACTIVE",
        "OS-EXT-AZ:availability_zone": "zone1-groupa",
        "created": "2012-09-07T16:56:37Z",
        "flavor": {
          "id": "05184ba3-00ba-4fbc-b7a2-03b62b884931",
          "links": [
            {
              "href": "https://baremetal-server-jp1-ecl.api.ntt.com-jp1-ecl.api.ntt.com/openstack/flavors/05184ba3-00ba-4fbc-b7a2-03b62b884931",
              "rel": "bookmark"
            }
          ]
        },
        "hostId": "16d193736a5cfdb60c697ca27ad071d6126fa13baeb670fc9d10645e",
        "id": "05184ba3-00ba-4fbc-b7a2-03b62b884931",
        "image": {
          "id": "70a599e0-31e7-49b7-b260-868f441e862b",
          "links": [
            {
              "href": "https://baremetal-server-jp1-ecl.api.ntt.com-jp1-ecl.api.ntt.com/v2/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931",
              "rel": "self"
            },
            {
              "href": "https://baremetal-server-jp1-ecl.api.ntt.com-jp1-ecl.api.ntt.com/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931",
              "rel": "bookmark"
            }
          ]
        },
        "metadata": {
          "My Server Name": "Apache1"
        },
        "name": "server-1",
        "progress": 100,
        "status": "ACTIVE",
        "tenant_id": "openstack",
        "updated": "2012-09-07T16:56:37Z",
        "user_id": "270dd02f-2abf-48bd-813a-f8a4470da7f7",
        "nic_physical_ports": [
          {
            "id": "39285bf9-12fb-4064-b98b-a552efc51cfc",
            "mac_addr": "0a:31:c1:d5:6d:9c",
            "network_physical_port_id": "38268d94-584a-4f14-96ff-732a68aa7301",
            "plane": "DATA",
            "attached_ports": [
              {
                "port_id": "61b7da1e-9571-4d63-b779-e003a56b8105",
                "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
                "fixed_ips": [
                  {
                    "subnet_id": "0419bbde-2b82-4107-9d8a-6bba76e364af",
                    "ip_address": "10.0.0.100"
                  }
                ]
              },
              {
                "port_id": "78b7da1e-9571-4d63-b779-e003a56b8105",
                "network_id": "3aa93722-1ec4-4912-b813-b975c21460a5",
                "fixed_ips": [
                  {
                    "subnet_id": "9419bbde-2b82-4107-9d8a-6bba76e364af",
                    "ip_address": "169.254.0.9"
                  }
                ]
              }
            ],
            "hardware_id": "c1e1546d-3063-46d0-8895-c6350eb691ff"
          },
          {
            "id": "7a6660bb-ce40-43bc-8f2e-2d235bbcacfa",
            "mac_addr": "8C:DC:D4:B7:48:31",
            "plane": "STORAGE",
            "network_physical_port_id": "b15cb499-99af-4cea-9777-afef9f5507af",
            "hardware_id": "cf52f380-bc12-4aa5-b197-91dc8d8f3602",
            "attached_ports": []
          },
          {
            "id": "47f48946-3b4b-4e86-a6d9-19357c50d8ca",
            "mac_addr": "8C:DC:D4:B7:48:4D",
            "plane": "STORAGE",
            "network_physical_port_id": "7abd96be-4597-4000-a0ff-cf854d0c9e3b",
            "hardware_id": "b8f73c6e-2710-4988-95ea-cc287241937c",
            "attached_ports": [],
          },
          {
            "id": "39285bf9-12fb-4064-b98b-a552efc51cfd",
            "mac_addr": "0a:31:c1:d5:6d:9d",
            "network_physical_port_id": "38268d94-584a-4f14-96ff-732a68aa7302",
            "plane": "DATA",
            "attached_ports": [
              {
                "port_id": "61b7da1e-9571-4d63-b779-e003a56b8106",
                "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
                "fixed_ips": [
                  {
                    "subnet_id": "0419bbde-2b82-4107-9d8a-6bba76e364af",
                    "ip_address": "10.0.0.101"
                  }
                ]
              }
            ],
            "hardware_id": "c1e1546d-3063-46d0-8895-c6350eb691fe"
          }
        ],
        "chassis-status": {
          "chassis-power": true,
          "power-supply": true,
          "cpu": true,
          "memory": true,
          "fan": true,
          "etc": true
        }
      }
    }
  ]
}