Mike.robski: 1 revision: Release 95

2014-07-02T22:43:45Z

1 revision: Release 95

Mike.robski at 22:41, 2 July 2014

2014-07-02T22:41:31Z

Mike.robski: 1 revision: Release 95

2014-07-02T22:29:08Z

1 revision: Release 95

Donghyun.kim: /* Response Codes */

2013-12-20T22:00:48Z

Response Codes

New page

= '''GET''' /accounts/''{accountId}''/loadbalancers/''{lbId}''/nodes/''{lbNodeId}'' =
This operation will retrieve all the information about a single node from a given load balancer.

== Request ==
=== URI Parameters ===
; accountId - ''string''
: The selected account Id.

; lbId
: The unique identifier of the load balancer.

; lbNodeId -- ''string''
: The specific node to be retrieved.

== Response ==

=== Response Codes ===
; 200 OK''

; 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.

; 404 Not Found
:The resource does not exist.

=== Response Body ===
<pre>
{
"id" : "{lbNodeId}",
"serverRef" : "{lbNodeServerRef}",
"port": "{lbNodePort}",
"condition" : "{lbCondition}",
}
</pre>

==== Parameters ====
; id - ''string''
: unique node identifier for node <n>

; serverRef - ''string''
: URL of this node

; port -- ''integer''
: The tcp port on node <n>'s server that will be used for load balancing

; condition -- ''string''
: either ENABLED or DISABLED

== Examples ==

=== Successfully list details for specified load balancer node ===

'''Request'''
<pre>
GET /accounts/{accountId}/loadbalancers/0001/nodes/{nodeId}
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string
</pre>

'''Response'''
<pre>
HTTP/1.1 200 OK

{
"id" : "1401",
"serverRef" : "http://blah.com/accounts/accountId/flexcloud/servers/sererId",
"port": "80",
"condition" : "ENABLED",
}
</pre>

=== Failure while trying to request details for a load balancer node from a non-existent load balancer ===
'''Request'''
<pre>
GET /accounts/{accountId}/loadbalancers/fake_load_balancer_id/nodes/1401
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string
</pre>

'''Response'''
<pre>
HTTP/1.1 404 Not Found

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

=== Failure while trying to request details for a load balancer node that does not exist ===
'''Request'''
<pre>
GET /accounts/{accountId}/loadbalancers/0001/nodes/fake_node_id
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string
</pre>

'''Response'''
<pre>
HTTP/1.1 404 Not Found

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

=== Failure while trying to make unauthorized access ===
'''Request'''
<pre>
GET /accounts/{accountId}/loadbalancers/0001/nodes/1401
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string
</pre>

'''Response'''
<pre>
HTTP/1.1 401 Unauthorized
</pre>

=== Failure while trying to pass invalid account number ===
'''Request'''
<pre>
GET /accounts/fake/loadbalancers/0001/nodes/1401
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string
</pre>

'''Response'''
<pre>
HTTP/1.1 404 Not Found
{
"itemNotFound" : {
"message": "Resource not found",
"code": 404,
"details": "",
"errorid": "59e0b3dd-2173-432a-8ff5-60efe16e83bf"
}
}
</pre>

[[Category:Hostway API]]
[[Category:Load Balancer API]]

@@ Line 153: / Line 153: @@
 </pre>
+{{disqus}}
 [[Category:Hostway API]]
 [[Category:Load Balancer API]]

Get one node from a given load balancer - Revision history

Mike.robski: 1 revision: Release 95

Mike.robski at 22:41, 2 July 2014

Mike.robski: 1 revision: Release 95

Donghyun.kim: /* Response Codes */