Mike.robski: 1 revision: Release 109

2015-07-24T18:13:14Z

1 revision: Release 109

Donghyun.kim: /* Response Body */

2015-02-04T22:46:18Z

Response Body

New page

= '''GET''' /accounts/''{accountId}''/loadbalancers/''{lbId}''/nodePools/''{nodePoolId}''/healthMonitor=
This operation lists the details for the specified health monitor

== Request ==
<code>GET /accounts/''{accountId}''/loadbalancers/''{lbId}''/nodePools/''{nodePoolId}''/healthMonitor</code>

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

; lbId - ''string''
: The selected loadbalancer id.

; nodePoolId - ''string''
: The selected node pool id.

== 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>
{
"protocol": "{protocol}",
"interval": {interval},
"port": {port},
"attemptsBeforeActivation": {count},
"attemptsBeforeDeactivation": {count},
"uri": "{uri}",
"links": [{"href": "http://{api-server}/accounts/{accountId}/loadbalancers/{lbId}/nodePools/{nodePoolId}/healthMonitor", "rel": "self"}]
}
</pre>

==== Parameters ====
; protocol - ''string''
: The protocol to be used by health monitor
: Allowed values are '''TCP''' or '''HTTP'''

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

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

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

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

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

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

== Examples ==

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

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

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

{
"protocol": "HTTP",
"interval": 60,
"port": 80,
"attemptsBeforeActivation": 5,
"attemptsBeforeDeactivation": 3,
"uri": "/check.php",
"links" : [{"href" : "http://{api-server}/accounts/{accountId}/loadbalancers/{lbId}/nodePools/{nodePoolId}/healthMonitor", "rel" : "self"}]

}
</pre>

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

Get a load balancer health monitor - Revision history

Mike.robski: 1 revision: Release 109

Donghyun.kim: /* Response Body */