Revision as of 15:56, 22 August 2014

This operation returns a list of all servers.

GET /accounts/{accountId}/flexcloud/servers?name=serverName&status=serverStatus&image=imageRef&zone=zoneTextKey&region=regionTextKey

Parameters

accountId - string

The selected account Id.

name - string

Optional Server name to search for.

status - string

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

without status filtering, return servers with ACTIVE, PROCESSING or STOPPED

image - string

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

zone - string

Optional Zone textkey

region - string

Optional Region textkey

Result

JSON

{
   "servers":[
      {
         "id":"{server_id}",
         "zone": "{zone_textkey}",
         "links":[
            {
               "href":"http://{api_server}/accounts/{accountId}/flexcloud/servers/{server_id}/",
               "rel":"self"
            }
         ]
      },
      {
         "id":"{server_id}",
         "zone": "{zone_textkey}",
         "links":[
            {
               "href":"http://{api_server}/accounts/{accountId}/flexcloud/servers/{server_id}/",
               "rel":"self"
            }
         ]
      }
   ]
}

id - string

Unique identifier for this server.

zone

Zone text key

links - array

Hypermedia for this resource.

Response Codes

Success

HTTP/1.1 200 OK

Failure

HTTP/1.1 401 Unauthorized : This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.

HTTP/1.1 404 Not Found : Resource does not exist

Examples

Successfully list servers

GET http(s)://{api_server}/accounts/{accountId}/flexcloud/servers

Request Headers:

   Content-Type:application/json
   Charset=UTF-8
   Authorization:Base64-encoded username & password string

Response Code:

HTTP/1.1 200 OK

Response Body:

{
    "servers" : [
       {
          "id": "test_server_0001",
          "zone": "AUS001",
          "links": [
             {
                "href": "http://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0001/", 
                "rel": "self"
             }
          ]
       },
       {
          "id": "test_server_0013",
          "zone": "zone",
          "links": [
             {
                "href": "http://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0013/", 
                "rel": "self"
             }
           ]
       },
       {
          "id": "test_server_0015",
          "zone": "AUS001",
          "links": [
             {
                "href": "http://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0015/", 
                "rel": "self"
             }
          ]
       }
    ]
}

Failure while trying to make unauthorized access

GET http://{api_server}/accounts/{accountId}/flexcloud/servers

Request Headers:

   Content-Type:application/json
   Charset=UTF-8
   Authorization:Base64-encoded fake_authentication_string

Response Code:

HTTP/1.1 401 Unauthorized

Response Body:

    401 Unauthorized
    This server could not verify that you are authorized to
    access the document you requested.  Either you supplied the
    wrong credentials (e.g., bad password), or your browser
    does not understand how to supply the credentials required.

Failure while trying to pass invalid account number

GET http(s)://{api_server}/accounts/{accountId}/flexcloud/servers

Request Headers:

   Content-Type:application/json
   Charset=UTF-8
   Authorization:Base64-encoded username & password string

Response Code:

HTTP/1.1 404 Not Found

Response Body:

 {
    "itemNotFound" : {
       "message": "Resource not found", 
       "code": 404, 
       "details": "",
       "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
    }
 }

Alternative URI /servers

An alternative way to execute this call is to omit the accountId portion of the URI. In this case the system assumes the request is executed for the account identified in the authorization header.

GET /servers