ServerListDetails

This operation will list all servers including their details.

GET /servers/detail?name=serverName&status=serverStatus&image=imageRef

Parameters

name - string

Server name to search for.

status - string

Server status to search for. Values: BUILD, ACTIVE, SUSPENDED, DELETED, UNKNOWN

image - string

Absolute URL of the image to filter servers by. e.g. http://{api_server}/images/{image_id}/

Result

JSON

{
   "servers":[
      {
         "status":"ACTIVE",
         "updated":"",
         "hostId":"host012-aus01.hyperv.hostway",
         "addresses":{
            "public":[
               {
                  "version":4,
                  "addr":"{ip_address}"
               }
            ],
            "private":[
               {
                  "version":4,
                  "addr":"{ip_address}"
               }
            ]
         },
         "links":[
            {
               "href":"http://{server_name}/servers/{server_id}/",
               "rel":"self"
            }
         ],
         "image":{
            "name":"Ubuntu 10.10 x64",
            "links":[
               {
                  "href":"http://{server_name}/images/20GB_Ubuntu%2010.10%20x64%20R1soft/",
                  "rel":"self"
               }
            ],
            "id":"20GB_Ubuntu 10.10 x64 R1soft"
         },
         "userId":"{user_account_id}",
         "flavor":{
            "name":"1024MB Server3",
            "links":[
               {
                  "href":"http://{server_name}/flavors/3/",
                  "rel":"self"
               }
            ],
            "id":3
         },
         "id":"{server_id}",
         "name":"{descriptive_server_name}",
         "created":"2011-12-05T12:51:28",
         "tenantId":"",
         "accessIPv4":"{ip_address}",
         "accessIPv6":"",
         "progress":100,
         "metadata":{
 
         }
      },
      {
         "status":"ACTIVE",
         "updated":"",
         "hostId":"host008-aus01.hyperv.hostway",
         "addresses":{
            "public":[
               {
                  "version":4,
                  "addr":"{ip_address}"
               }
            ],
            "private":[
               {
                  "version":4,
                  "addr":"{ip_address}"
               }
            ]
         },
         "links":[
            {
               "href":"http://{server_name}/servers/{server_id}/",
               "rel":"self"
            }
         ],
         "image":{
            "name":"Windows 2008 R2 Standard ",
            "links":[
               {
                  "href":"http://{server_name}/images/20GB_Windows%202008%20R2%20Standard%20with%20R1soft/",
                  "rel":"self"
               }
            ],
            "id":"20GB_Windows 2008 R2 Standard with R1soft"
         },
         "userId":"{user_account_id}",
         "flavor":{
            "name":"1024MB Server3",
            "links":[
               {
                  "href":"http://{server_name}/flavors/3/",
                  "rel":"self"
               }
            ],
            "id":3
         },
         "id":"{server_id}",
         "name":"{descriptive_server_name}",
         "created":"2011-11-17T10:14:58",
         "tenantId":"",
         "accessIPv4":"{ip_address}",
         "accessIPv6":"",
         "progress":100,
         "metadata":{
 
         }
      }
   ]
}

server

id - string

Unique identifier for this server.

links - list

Hypermedia for this resource.

status - string

Current state of the server. Values: BUILD, ACTIVE, SUSPENDED, DELETED, UNKNOWN

hostId - string

Id of the physical host this virtual machine is running on.

userId - string

Unique identifier for the owner of this server.

name - string

Descriptive name for this server.

created - string

The date and time this server was created. ISO 8601 format, YYYY-MM-DDTHH:MM:SS.

accessIPv4 - string

The default included public IPv4 address.

progress - number

The progress of the current this server while in the BUILD status. The value is in the range of 0 - 100, but currently will only even be 0, 50, 100.

metadata - object

Unused always an empty object.

tenantId

Unused always always null.

accessIPv6

Unused always null.

updated

Unused always null.

addresses

addresses.public.version - number

IP version of this address. Values: 4

addresses.public.addr = string

Public IP address of this server

addresses.private.version - number

IP version of this address. Values: 4

addresses.private.addr - string

Private IP address of this server

image

image.name - string

The display name of the image this server is based on.

image.links - list

Hypermedia for the image.

image.id - string

Unique identifier for image this server is based on.

flavor

flavor.name - string

The display name of the flavor this server is based on.

flavor.links - list

Hypermedia for the flavor.

flavor.id - string

Unique identifier for flavor this server is based on.

blog comments powered by Disqus