Edit a load balancer - Revision history

Mike.robski: 1 revision: Release 109

2015-07-24T18:13:14Z

1 revision: Release 109

Mike.robski at 16:17, 6 February 2015

2015-02-06T16:17:59Z

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:53Z

Mike.robski: 1 revision: Release 95

2014-07-02T22:29:08Z

1 revision: Release 95

Youngbae.oh: /* Examples */

2014-01-09T20:55:33Z

Examples

New page

='''PUT''' /accounts/''{accountId}''/loadbalancers/''{lbId}''=
This operation will update name and/or algorithm of the specified load balancer.

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

; lbId - ''string''
: The unique identifier of the firewall group.

=== Request Body ===
<nowiki>
{
"displayName" : "{lbDisplayName}",
"algorithm" : "{lbAlgorithm}",
"timeout": {lbTimeout},
"protocol": "{lbProtocol}"
}
}</nowiki>

==== Parameters ====
; displayName - ''string''
: optional, new name for this load balancer (must be unique)

; algorithm - ''string''
: optional, the new load balancing algorithm to use. ROUND_ROBIN or SOURCE_IP

; timeout - ''integer''
: optional, timeout seconds

; protocol - ''string''
: optional, HTTP or TCP

== Response ==

=== Response Codes ===
; 204 No Content

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

== Examples ==

=== Successfully edit details for specified load balancer ===

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

{
"displayName": "New display name",
"algorithm": "SOURCE_IP"
}</pre>

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

=== Failure while trying to edit a load balancer that does not exist ===

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

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

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

@@ Line 1: / Line 1: @@
 ='''PUT''' /accounts/''{accountId}''/loadbalancers/''{lbId}''=
-This operation will update name and/or algorithm of the specified load balancer.
+This operation updates the specified load balancer attributes.
 == Request ==
-=== URI Parameters ===
+<code>PUT /accounts/''{accountId}''/loadbalancers/''{lbId}''</code>
 ; accountId - ''string''
-: The selected account Id.
+: The selected account id.
 ; lbId - ''string''
-: The unique identifier of the firewall group.
+: The selected load balancer id.
 === Request Body ===
   <nowiki>
+{
-       "displayName" : "{lbDisplayName}",
+    "displayName": "{lbDisplayName}"
-       "algorithm" : "{lbAlgorithm}",
+}</nowiki>
-       "timeout": {lbTimeout},
-       "protocol": "{lbProtocol}"
-−
- }</nowiki>
 ==== Parameters ====
 ; displayName - ''string''
-: optional, new name for this load balancer (must be unique)
+: new name for this load balancer
-−
-; algorithm - ''string''
-: optional, the new load balancing algorithm to use. ROUND_ROBIN or SOURCE_IP
-−
-; timeout - ''integer''
-: optional, timeout seconds
-−
-; protocol - ''string''
-: optional, HTTP or TCP
 == Response ==
@@ Line 37: / Line 26: @@
 === Response Codes ===
 ; 204 No Content
 ; 401 Unauthorized
@@ Line 53: / Line 45: @@
 Content-Type:application/json
 Charset=UTF-8
-Authorization:Base64-encoded username & password string
+Authorization: Basic {Base64-encoded username & password string}
+{
-     "displayName": "New display name",
+     "displayName": "New display name"
-    "algorithm": "SOURCE_IP"
 }</pre>
@@ Line 63: / Line 54: @@
 <pre>
 HTTP/1.1 204 OK
 </pre>

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