ListServerIPs

From Hostway API Documentation
(Difference between revisions)
Jump to: navigation, search
(Created page with "This operation will list all flexible IPs assigned to a specific Server. ='''GET''' /servers/'''id'''/ips''= == Parameters == ; id : The unique identifier of the server....")
 
m (1 revision: Release 86)
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
This operation will list all flexible IPs assigned to a specific [[Server]].
 
This operation will list all flexible IPs assigned to a specific [[Server]].
  
−
='''GET''' /servers/'''id'''/ips''=
+
='''GET''' /accounts/''{accountId}''/flexcloud/servers/''{id}''/ips''=
  
 
== Parameters ==
 
== Parameters ==
 +
; accountId - ''string''
 +
: The selected account Id.
 +
 
; id
 
; id
 
: The unique identifier of the server.
 
: The unique identifier of the server.
Line 27: Line 30:
 
   "links" : [
 
   "links" : [
 
       {
 
       {
−
         "href" : "http://{api_server}/servers/{server_id}/ips",  
+
         "href" : "http://{api_server}/accounts/{accountId}/flexcloud/servers/{server_id}/ips",  
 
         "rel": "self"
 
         "rel": "self"
 
       }
 
       }
 
   ]
 
   ]
−
}
+
}</nowiki>
−
</nowiki>
+
  
 
; addr - ''string''
 
; addr - ''string''
Line 50: Line 52:
  
 
'''Successfully list all flexible IPs assigned to the specified server'''
 
'''Successfully list all flexible IPs assigned to the specified server'''
−
:'''GET''' http(s)://{api_server}/servers/test_server_0013/ips
+
:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0013/ips
  
  
Line 80: Line 82:
 
   "links" : [
 
   "links" : [
 
       {
 
       {
−
         "href" : "http://{api_server}/servers/test_server_0013/ips",  
+
         "href" : "http://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0013/ips",  
 
         "rel": "self"
 
         "rel": "self"
 
       }
 
       }
 
   ]
 
   ]
−
}
+
}</nowiki>
−
</nowiki>
+
  
 
'''Unauthorized access'''
 
'''Unauthorized access'''
−
:'''GET''' http(s)://{api_server}/servers/test_server_0013/ips
+
:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0013/ips
  
  
Line 107: Line 108:
  
 
'''Failure while trying to list flexible IPs for a non-existent server'''
 
'''Failure while trying to list flexible IPs for a non-existent server'''
−
:'''GET''' http(s)://{api_server}/servers/{<span style="color:red">fake_server_id</span>}/ips
+
:'''GET''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/{<span style="color:red">fake_server_id</span>}/ips
  
  
Line 119: Line 120:
  
 
''Response Body:''
 
''Response Body:''
 +
<nowiki>
 
  {
 
  {
 
     "itemNotFound" : {
 
     "itemNotFound" : {
 
       "message": "Resource not found",  
 
       "message": "Resource not found",  
 
       "code": 404,  
 
       "code": 404,  
−
       "details": ""
+
       "details": "",
 +
      "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
 
     }
 
     }
−
  }
+
  }</nowiki>
  
 +
'''Failure while trying to pass invalid account number'''
 +
:'''GET''' http(s)://{api_server}/accounts/fake/flexcloud/servers/test_server_0013/ips
 +
 +
 +
''Request Headers:''
 +
    Content-Type:application/json
 +
    Charset=UTF-8
 +
    Authorization:Base64-encoded username & password string
 +
 +
''Response Code:''
 +
<pre>HTTP/1.1 404 Not Found</pre>
 +
 +
''Response Body:''
 +
<nowiki>
 +
{
 +
    "itemNotFound" : {
 +
      "message": "Resource not found",
 +
      "code": 404,
 +
      "details": "",
 +
      "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
 +
    }
 +
}</nowiki>
  
−
<!--  THIS CODE ENABLES DISQUS COMMENTS ON THE PAGE - DELETE TO DISABLE COMMENTING-->
+
== Alternative URI /servers/{id}/ips ==
 +
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 [[Authentication|authorization header]].
  
−
{{#widget:DISQUS
+
<code>GET /servers/{id}/ips</code>
−
|id=hostway
+
−
|uniqid={{PAGENAME}}
+
−
|url={{fullurl:{{PAGENAME}}}}
+
−
}}
+
  
−
<!--  ########################################################################### -->
+
[[Category:Hostway API]]
 +
[[Category:FlexCloud Server API]]

Latest revision as of 11:00, 11 October 2013

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

Contents

[edit] GET /accounts/{accountId}/flexcloud/servers/{id}/ips

[edit] Parameters

accountId - string
The selected account Id.
id
The unique identifier of the server.

[edit] Result

[edit] JSON 

{
   "addresses" : {
      "public" : [
         {
            "version" : 4, 
            "addr" : "{ip_address}"
         }
      ], 
      "private" : [
         {
            "version" : 4, 
            "addr" : "{ip_address}"
         }
      ]
   }, 
   "links" : [
      {
         "href" : "http://{api_server}/accounts/{accountId}/flexcloud/servers/{server_id}/ips", 
         "rel": "self"
      }
   ]
}
addr - string
The address of the allocated flexible IP.
links - array
Hypermedia for this resource.

[edit] 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.

[edit] Examples

Successfully list all flexible IPs assigned to the specified server

GET http(s)://{api_server}/accounts/{accountId}/flexcloud/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}/accounts/{accountId}/flexcloud/servers/test_server_0013/ips", 
         "rel": "self"
      }
   ]
}

Unauthorized access

GET http(s)://{api_server}/accounts/{accountId}/flexcloud/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}/accounts/{accountId}/flexcloud/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": "",
       "errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
    }
 }

Failure while trying to pass invalid account number

GET http(s)://{api_server}/accounts/fake/flexcloud/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 404 Not Found

Response Body: 

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

[edit] Alternative URI /servers/{id}/ips

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/{id}/ips

Retrieved from "http://docs.hostway.com/index.php?title=ListServerIPs&oldid=930"
Personal tools
Namespaces
Variants
Actions
APIs
Navigation
Toolbox