List Load Balancers - Revision history

Mike.robski: 1 revision: Release 109

2015-07-24T18:13:13Z

1 revision: Release 109

Donghyun.kim: /* Response Body */

2015-02-04T22:47:36Z

Response Body

Show changes

Mike.robski: 1 revision: Release 97

2014-08-20T17:49:47Z

1 revision: Release 97

Donghyun.kim: /* Successfully list load balancers with pagination */

2014-08-05T18:23:48Z

Successfully list load balancers with pagination

Mike.robski: 1 revision: Release 95

2014-07-02T22:43:44Z

1 revision: Release 95

Mike.robski at 22:40, 2 July 2014

2014-07-02T22:40:27Z

Mike.robski: 1 revision: Release 95

2014-07-02T22:29:08Z

1 revision: Release 95

Youngbae.oh: /* Request */

2014-01-09T19:27:34Z

Request

New page

='''GET''' /accounts/''{accountId}''/loadbalancers=
This operation lists existing load balancers.

== Request ==
<code>GET /accounts/{accountId}/loadbalancers?virtualIp={virtualIp}&region={region}

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

=== URI Parameters ===
; virtualIp - ''string''
: optional, only loadbalancers with specified virtualIp will be returned

; region - ''string''
: optional, only loadbalancers in the specified region will be returned

== 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 ===
<nowiki>
{
"list" : [
{
"id": "743",
"protocol": "HTTP",
"algorithm": "ROUND_ROBIN",
"region": "ote.2008.tampa",
"virtualIp": "10.140.141.88",
"port": 80,
"healthMonitor": {},
"timeout": 5,
"displayName": "test-lb-name",
"nodes": [
{
"serverRef": "http://localhost:6543/accounts/jello614636/flexcloud/servers/jello614636-USOTE-2008-TAMPA-0002",
"id": "1344",
"condition": "ENABLED",
"port": 80
}
],
"sessionPersistence": {}
}
],
"links" : [
{
"href" : "http://{api-server}/accounts/{accountId}/loadbalancers",
"rel" : "self"
}
],
}</nowiki>

==== Parameters ====
; list
: the list of loadbalancers

; links - ''list''
: [[Hypermedia]] for this resource.

== Examples ==

=== Successfully list load balancers ===

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

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

{
"list" : [
{
"id": "743",
"protocol": "HTTP",
"algorithm": "ROUND_ROBIN",
"region": "ote.2008.tampa",
"virtualIp": "10.140.141.88",
"port": 80,
"healthMonitor": {},
"timeout": 5,
"displayName": "test-lb-name",
"nodes": [
{
"serverRef": "http://localhost:6543/accounts/jello614636/flexcloud/servers/jello614636-USOTE-2008-TAMPA-0002",
"id": "1344",
"condition": "ENABLED",
"port": 80
}
],
"sessionPersistence": {}
}
],
"links" : [
{
"href" : "http://{api-server}/accounts/{accountId}/loadbalancers",
"rel" : "self"
}
],
}
</pre>

=== Failure while trying to make unauthorized access ===

'''Request'''
<pre>
POST /accounts/{accountId}/loadbalancers
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>
POST /accounts/fake/loadbalancers
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded <span style="color:red">fake_authentication_string</span>
</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 15: / Line 15: @@
 ; region - ''string''
 : optional, only loadbalancers in the specified region will be returned
 == Response ==
@@ Line 97: / Line 116: @@
             "nodes": [
+                {
-                    "serverRef": "http://localhost:6543/accounts/jello614636/flexcloud/servers/jello614636-USOTE-2008-TAMPA-0002",
+                    "serverRef": "http://{api-server}/accounts/{accountId}/flexcloud/servers/{serverId}",
                     "id": "1344",
                     "condition": "ENABLED",
@@ Line 112: / Line 131: @@
+        }
      ],
+  }
 </pre>

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