ListServerIPs

Revision as of 19:16, 12 April 2013

This operation will list all flexible IPs assigned to a specific Server.

GET /servers/id/ips

Parameters

id

The unique identifier of the server.

Result

JSON

{
   "addresses" : {
      "public" : [
         {
            "version" : 4, 
            "addr" : "{ip_address}"
         }
      ], 
      "private" : [
         {
            "version" : 4, 
            "addr" : "{ip_address}"
         }
      ]
   }, 
   "links" : [
      {
         "href" : "http://{api_server}/servers/{server_id}/ips", 
         "rel": "self"
      }
   ]
}

addr - string

The address of the allocated flexible IP.

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 incorrect credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.

HTTP/1.1 404 Not Found - Resource not found.

Examples

Successfully list all flexible IPs assigned to the specified server

GET http(s)://{api_server}/servers/test_server_0013/ips

Request Headers:

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

Response Code:

HTTP/1.1 200 OK

Response Body:

{
   "addresses" : {
      "public" : [
         {
            "version" : 4, 
            "addr" : "{ip_address}"
         }
      ], 
      "private" : [
         {
            "version" : 4, 
            "addr" : "{ip_address}"
         }
      ]
   }, 
   "links" : [
      {
         "href" : "http://{api_server}/servers/test_server_0013/ips", 
         "rel": "self"
      }
   ]
}

Unauthorized access

GET http(s)://{api_server}/servers/test_server_0013/ips

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 list flexible IPs for a non-existent server

GET http(s)://{api_server}/servers/{fake_server_id}/ips

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": ""
   }
}