Add or update load balancer's health monitor - Revision history

Mike.robski: 1 revision: Release 109

2015-07-24T18:13:14Z

1 revision: Release 109

Donghyun.kim at 18:10, 6 February 2015

2015-02-06T18:10:23Z

Mike.robski: 1 revision: Release 95

2014-07-02T22:43:45Z

1 revision: Release 95

Mike.robski at 22:42, 2 July 2014

2014-07-02T22:42:25Z

Mike.robski: 1 revision: Release 95

2014-07-02T22:29:08Z

1 revision: Release 95

Youngbae.oh: /* Examples */

2014-01-09T20:57:18Z

Examples

New page

This operation will add or modify a load balancer's health monitor

='''PUT''' /accounts/''{accountId}''/loadbalancers/''{lbId}''/healthmonitor

== Request ==

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

; lbId
: The unique identifier of the load balancer.

=== Request Body ===
<pre>
{
"protocol":"{protocol}",
"interval":{interval},
"port":{port},
"attemptsBeforeActivation":{count},
"attemptsBeforeDeactivation":{count},
"uri": "{uri}"
}
</pre>

==== Parameters ====
; protocol - ''string''
: protocol of health monitor (TCP or HTTP)

; interval - ''integer''
: The number of seconds between subsequent health monitor check messages

; port - ''integer''
: port for health monitor

; attemptsBeforeActivation - ''integer''
: Number of successful health monitor checks allowed before this load balancer is activated

; attemptsBeforeDeactivation - ''integer''
: Number of failed health monitor checks allowed before this load balancer is deactivated

; uri - ''string''
: optional, http path for monitor, if the protocol is HTTP

== 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 update contents of specified load balancer health monitor ===
'''Request'''
<pre>
PUT /accounts/{accountId}/loadbalancers/0001/healthmonitor
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

{
"protocol":"TCP",
"interval":20,
"port":80,
"attemptsBeforeActivation":3,
"attemptsBeforeDeactivation":3
}
</pre>

'''Response'''
<pre>
HTTP/1.1 204 No Content

</pre>

=== Failure while trying to update the health monitor of a non-existent load balancer ===
'''Request'''
<pre>
PUT /accounts/{accountId}/loadbalancers/fake_loadBalancerId/healthmonitor
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

{
"protocol":"TCP",
"interval":20,
"port":10,
"attemptsBeforeActivation":3,
"attemptsBeforeDeactivation":3
}

</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 1: / Line 1: @@
-This operation will add or modify a load balancer's health monitor
+='''PUT''' /accounts/''{accountId}''/loadbalancers/''{lbId}''/nodePools/''{nodePoolId}''/healthMonitor=
+This operation adds or modify a load balancer's health monitor
-='''PUT''' /accounts/''{accountId}''/loadbalancers/''{lbId}''/healthmonitor
 == Request ==
-=== URI Parameters ===
+=== Request Parameters ===
 ; accountId - ''string''
-: The selected account Id
+: The selected account id.
-; lbId
+; nodePoolId - ''string''
-: The unique identifier of the load balancer.
+: The selected node pool id.
 === Request Body ===
-<pre>
+partial update is not supported, need all data to add or update
+{
-     "protocol":"{protocol}",
+     "protocol": "{protocol}",
-     "interval":{interval},
+     "interval": {interval},
-     "port":{port},
+     "port": {port},
-     "attemptsBeforeActivation":{count},
+     "attemptsBeforeActivation": {count},
-     "attemptsBeforeDeactivation":{count},
+     "attemptsBeforeDeactivation": {count},
      "uri": "{uri}"
+}</nowiki>
-</pre>
 ==== Parameters ====
 ; protocol - ''string''
-: protocol of health monitor (TCP or HTTP)
+: The protocol to be used by health monitor
 ; interval - ''integer''
@@ Line 32: / Line 36: @@
 ; port - ''integer''
-: port for health monitor
+: The port for health monitor to monitor
 ; attemptsBeforeActivation - ''integer''
-: Number of successful health monitor checks allowed before this load balancer is activated
+: The number of successful health monitor checks allowed before this load balancer is activated
 ; attemptsBeforeDeactivation - ''integer''
-: Number of failed health monitor checks allowed before this load balancer is deactivated
+: The number of failed health monitor checks allowed before this load balancer is deactivated
 ; uri - ''string''
-: optional, http path for monitor, if the protocol is HTTP
+: Optional, http path for monitor, needed only if the protocol is HTTP
 == Response ==
@@ Line 47: / Line 51: @@
 === Response Codes ===
 ; 204 No Content
 ; 401 Unauthorized
@@ Line 59: / Line 66: @@
 '''Request'''
 <pre>
-PUT /accounts/{accountId}/loadbalancers/0001/healthmonitor
+PUT /accounts/{accountId}/loadbalancers/0001/nodePools/123/healthMonitor
 Content-Type:application/json
 Charset=UTF-8
-Authorization:Base64-encoded username & password string
+Authorization: Basic {Base64-encoded username & password string}
+{
-     "protocol":"TCP",
+     "protocol": "TCP",
-     "interval":20,
+     "interval": 20,
-     "port":80,
+     "port": 80,
-     "attemptsBeforeActivation":3,
+     "attemptsBeforeActivation": 3,
-     "attemptsBeforeDeactivation":3
+     "attemptsBeforeDeactivation": 3
+}
 </pre>
@@ Line 79: / Line 86: @@
 </pre>
 [[Category:Hostway API]]
 [[Category:Load Balancer API]]