Health Monitor

Media Type
[application/vnd.org.midonet.HealthMonitor-v1+json]
Collection Media Type
[application/vnd.org.midonet.collection.HealthMonitor-v1+json]
GET      /health_monitors
GET      /health_monitors/:healthMonitorId
POST     /health_monitors
PUT      /health_monitors/:healthMonitorId
DELETE   /health_monitors/:healthMonitorId
[Note]Note

To use this feature, please make sure that health monitoring is activated in the MidoNet Agent configuration. See HAProxy configuration in the Operation Guide for details.

A HealthMonitor is an entity that represents a virtual health monitor device for use with load balancers in MidoNet. It contains the following fields:

Field NameTypePOST/PUTRequiredDescription

uri

URI

  

A GET against this URI refreshes the representation of this resource.

pools

URI

  

A GET against this URI returns the pools monitored by this healh monitor.

id

UUID

POST

No

A unique identifier of the resource. If this field is omitted in the POST request, a random UUID is generated.

type

String

POST/PUT

Yes

The type of the health monitor checking protocol. The following type is supported: TCP.

adminStateUp

Boolean

POST/PUT

No

The administrative state of the health monitor. The default is true (up).

delay

Integer

POST/PUT

No

The delay for the health check interval in seconds. The default is zero.

maxRetries

Integer

POST/PUT

No

The number of times to retry for health check. The defaults is zero.

timeout

Integer

POST/PUT

No

The timeout value for the health check in seconds. The defaults is zero.

Questions? Discuss on Mailing Lists or Chat.
Found an error? Report a bug.