List Servers¶
Overview¶
This API lists your Dedicated Hypervisor servers information.
Classification¶
- List
API Operation Object¶
Synchronous / Asynchronous¶
- Synchronous
Request¶
HTTP Request Method¶
- GET
HTTP Request Path¶
{api_endpoint}/v1.0/{tenant_id}/servers
HTTP Request Header¶
Accept: application/json
Content-Type: application/json
X-Auth-Token: <token>
HTTP Request Body¶
Format¶
{
"servers": "<servers>"
}
Request Parameter¶
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 Glance 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¶
Sample Request and Response¶
Sample API Request¶
Request URI¶
https://dedicated-hypervisor-jp1-ecl.api.ntt.com/v1.0/b322a85578de48beba0f92acce57869b/servers
HTTP Request Header¶
GET /v1.0/b322a85578de48beba0f92acce57869b/servers
User-Agent: curl/7.35.0
Host: 192.168.150.51:8774
Content-Type: application/json
Accept: application/json
X-Auth-Token: 62d528dc0cca4827b0ed465efe1c2588
HTTP Request Body¶
- none
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": [
{
"baremetal_server": {
"name": "new-server-test",
"links": [
{
"rel": "self",
"href": "https://baremetal-server-jp1-ecl.api.ntt.com/v2/f118d06a83ce49938b3cf6bf3400e4cd/servers/28488804-86bc-413b-9227-ba1a40de69d3"
},
{
"rel": "bookmark",
"href": "https://baremetal-server-jp1-ecl.api.ntt.com/f118d06a83ce49938b3cf6bf3400e4cd/servers/28488804-86bc-413b-9227-ba1a40de69d3"
}
],
"id": "28488804-86bc-413b-9227-ba1a40de69d3"
},
"links": [
{
"rel": "self",
"href": "https://dedicated-hypervisor-jp1-ecl.api.ntt.com/v1.0/f118d06a83ce49938b3cf6bf3400e4cd/servers/347708f8-cd51-42b1-b3c3-a0597514e982"
},
{
"rel": "bookmark",
"href": "https://dedicated-hypervisor-jp1-ecl.api.ntt.com/f118d06a83ce49938b3cf6bf3400e4cd/servers/347708f8-cd51-42b1-b3c3-a0597514e982"
}
],
"name": "new-server-test",
"id": "347708f8-cd51-42b1-b3c3-a0597514e982"
},
{
"baremetal_server": {
"name": "new-server-test2",
"links": [
{
"rel": "self",
"href": "https://baremetal-server-jp1-ecl.api.ntt.com/v2/f118d06a83ce49938b3cf6bf3400e4cd/servers/28488804-86bc-413b-9227-ba1a40de69d4"
},
{
"rel": "bookmark",
"href": "https://baremetal-server-jp1-ecl.api.ntt.com/f118d06a83ce49938b3cf6bf3400e4cd/servers/28488804-86bc-413b-9227-ba1a40de69d4"
}
],
"id": "28488804-86bc-413b-9227-ba1a40de69d4"
},
"links": [
{
"rel": "self",
"href": "https://dedicated-hypervisor-jp1-ecl.api.ntt.com/v1.0/f118d06a83ce49938b3cf6bf3400e4cd/servers/347708f8-cd51-42b1-b3c3-a0597514e983"
},
{
"rel": "bookmark",
"href": "https://dedicated-hypervisor-jp1-ecl.api.ntt.com/f118d06a83ce49938b3cf6bf3400e4cd/servers/347708f8-cd51-42b1-b3c3-a0597514e983"
}
],
"name": "new-server-test2",
"id": "347708f8-cd51-42b1-b3c3-a0597514e983"
}
]
}