List Servers Details¶

Overview¶

This API lists your baremetal servers information in detail.

Classification¶

List

API Operation Object¶

Server

Synchronous / Asynchronous¶

Synchronous

Request¶

HTTP Request Method¶

GET

HTTP Request Path¶

{api_endpoint}/v2/{tenant_id}/servers/detail?changes-since={changes-since}?limit={limit}&

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
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 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://baremetal-server-jp1-ecl.api.ntt.com/v2/b322a85578de48beba0f92acce57869b/servers/detail?limit=10&flavor=http://controller:port/v2/flavors/{flavor_id}

HTTP Request Header¶

GET /v2/b322a85578de48beba0f92acce57869b/servers/detail?limit=10&flavor=http://controller:port/v2/flavors/{flavor_id} 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¶

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": [
    {
      "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/openstack/flavors/05184ba3-00ba-4fbc-b7a2-03b62b884931",
            "rel": "bookmark"
          }
        ]
      },
      "id": "05184ba3-00ba-4fbc-b7a2-03b62b884931",
      "image": {
        "id": "70a599e0-31e7-49b7-b260-868f441e862b",
        "links": [
          {
            "href": "https://baremetal-server-jp1-ecl.api.ntt.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
            "rel": "bookmark"
          }
        ]
      },
      "links": [
        {
          "href": "https://baremetal-server-jp1-ecl.api.ntt.com/v2/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931",
          "rel": "self"
        },
        {
          "href": "https://baremetal-server-jp1-ecl.api.ntt.com/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931",
          "rel": "bookmark"
        }
      ],
      "metadata": {
        "My Server Name": "Apache1"
      },
      "name": "new-server-test",
      "progress": 0,
      "status": "ACTIVE",
      "tenant_id": "openstack",
      "updated": "2012-09-07T16:56:37Z",
      "user_id": "fake",
      "raid_arrays": [
        {
          "primary_storage": true,
          "raid_card_hardware_id": "raid_card_uuid",
          "disk_hardware_ids": [
            "disk0_uuid",
            "disk1_uuid",
            "disk2_uuid",
            "disk3_uuid"
          ],
          "partitions": [
            {
              "lvm": true,
              "partition_label": "primary-part1"
            },
            {
              "lvm": false,
              "size": "100G",
              "partition_label": "var"
            }
          ]
        },
        {
          "primary_storage": false,
          "raid_card_hardware_id": "raid_card_uuid",
          "internal_disk_ids": [
            "disk4_uuid",
            "disk5_uuid",
            "disk6_uuid",
            "disk7_uuid"
          ],
          "raid_level": 10,
          "partitions": [
            {
              "lvm": true,
              "partition_label": "secondary-part1"
            }
          ]
        }
      ],
      "lvm_volume_groups": [
        {
          "vg_label": "VG_root",
          "physical_volume_partition_labels": [
            "primary-part1",
            "secondary-part1"
          ],
          "logical_volumes": [
            {
              "lv_label": "LV_root"
            },
            {
              "size": "2G",
              "lv_label": "LV_swap"
            }
          ]
        }
      ],
      "filesystems": [
        {
          "label": "LV_root",
          "mount_point": "/",
          "fs_type": "xfs"
        },
        {
          "label": "var",
          "mount_point": "/var",
          "fs_type": "xfs"
        },
        {
          "label": "LV_swap",
          "fs_type": "swap"
        }
      ],
      "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": "9aa93722-1ec4-4912-b813-b975c21460a5",
              "fixed_ips": [
                {
                  "subnet_id": "0419bbde-2b82-4107-9d8a-6bba76e364af",
                  "ip_address": "192.168.10.2"
                }
              ]
            }
          ],
          "hardware_id": "063468e8-61ab-4afd-be38-c937254aeb9a"
        }
      ],
      "chassis-status": {
        "chassis-power": true,
        "power-supply": true,
        "cpu": true,
        "memory": true,
        "fan": true,
        "disk": 0,
        "nic": true,
        "system-board": true,
        "etc": true
      },
      "media_attachments": [],
      "personality": [
        {
          "path": "/home/big/banner.txt",
          "contents": "ZWNobyAiS3VtYSBQZXJzb25hbGl0eSIgPj4gL2hvbWUvYmlnL3BlcnNvbmFsaXR5"
        }
      ]
    },
    {
      "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": "1",
        "links": [
          {
            "href": "https://baremetal-server-jp1-ecl.api.ntt.com/openstack/flavors/1",
            "rel": "bookmark"
          }
        ]
      },
      "hostId": "16d193736a5cfdb60c697ca27ad071d6126fa13baeb670fc9d10645e",
      "id": "05184ba3-00ba-4fbc-b7a2-03b62b884932",
      "image": {
        "id": "70a599e0-31e7-49b7-b260-868f441e862b",
        "links": [
          {
            "href": "https://baremetal-server-jp1-ecl.api.ntt.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
            "rel": "bookmark"
          }
        ]
      },
      "links": [
        {
          "href": "https://baremetal-server-jp1-ecl.api.ntt.com/v2/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931",
          "rel": "self"
        },
        {
          "href": "https://baremetal-server-jp1-ecl.api.ntt.com/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931",
          "rel": "bookmark"
        }
      ],
      "metadata": {
        "My Server Name": "Apache1"
      },
      "name": "new-server-test",
      "progress": 0,
      "status": "ACTIVE",
      "tenant_id": "openstack",
      "updated": "2012-09-07T16:56:37Z",
      "user_id": "fake",
      "raid_arrays": [
        {
          "primary_storage": true,
          "raid_card_hardware_id": "raid_card_uuid",
          "disk_hardware_ids": [
            "disk0_uuid",
            "disk1_uuid",
            "disk2_uuid",
            "disk3_uuid"
          ],
          "partitions": [
            {
              "lvm": true,
              "partition_label": "primary-part1"
            },
            {
              "lvm": false,
              "size": "100G",
              "partition_label": "var"
            }
          ]
        },
        {
          "primary_storage": false,
          "raid_card_hardware_id": "raid_card_uuid",
          "internal_disk_ids": [
            "disk4_uuid",
            "disk5_uuid",
            "disk6_uuid",
            "disk7_uuid"
          ],
          "raid_level": 10,
          "partitions": [
            {
              "lvm": true,
              "partition_label": "secondary-part1"
            }
          ]
        }
      ],
      "lvm_volume_groups": [
        {
          "vg_label": "VG_root",
          "physical_volume_partition_labels": [
            "primary-part1",
            "secondary-part1"
          ],
          "logical_volumes": [
            {
              "lv_label": "LV_root"
            },
            {
              "size": "2G",
              "lv_label": "LV_swap"
            }
          ]
        }
      ],
      "filesystems": [
        {
          "label": "LV_root",
          "mount_point": "/",
          "fs_type": "xfs"
        },
        {
          "label": "var",
          "mount_point": "/var",
          "fs_type": "xfs"
        },
        {
          "label": "LV_swap",
          "fs_type": "swap"
        }
      ],
      "nic_physical_ports": [
        {
          "id": "f4732cd9-31f7-408e-9f27-cc9b0ee17457",
          "mac_addr": "0a:31:c1:d5:6d:9d",
          "network_physical_port_id": "ab17a82d-e9a5-4e95-9b18-de3f8a47670f",
          "plane": "storage",
          "attached_ports": [
            {
              "port_id": "6fb0d979-f05b-466c-b50c-64d5ae4c4ef6",
              "network_id": "99babdfc-79eb-470a-b0d4-df02482cc509",
              "fixed_ips": [
                {
                  "subnet_id": "9632ce5d-8750-40bf-871d-968aa3324367",
                  "ip_address": "192.168.10.8"
                }
              ]
            }
          ],
          "hardware_id": "ab36f541-b854-46c3-8891-e9484a1ba1ac"
        }
      ],
      "chassis-status": {
        "chassis-power": true,
        "power-supply": true,
        "cpu": true,
        "memory": true,
        "fan": true,
        "disk": 0,
        "nic": true,
        "system-board": true,
        "etc": true
      },
      "media_attachments": [
        {
          "image": {
            "id": "3339fd5f-ec06-4ef8-9337-c1c70218a748",
            "links": [
              {
                "href": "https://baremetal-server-jp1-ecl.api.ntt.com/openstack/images/3339fd5f-ec06-4ef8-9337-c1c70218a748",
                "rel": "bookmark"
              }
            ]
          }
        }
      ]
    }
  ]
}

List Servers

Show Server