This section discusses operations for managing load balancer health monitors through the LBaaS extension.
| Attribute | Type | Required | CRUD [a] | Default value | Validation constraints | Notes | |||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| id | uuid-str | N/A | R | generated | N/A | Unique ID for the health monitor. | |||||||||||||||||||||||||||||||||||||||||||
| tenant_id | uuid-str | Yes | CR | Derived from authentication token. | N/A | Owner of the health monitor. Only an admin user can specify a tenant identifier other than its own. | |||||||||||||||||||||||||||||||||||||||||||
| type | String | Yes | CR | None | {"PING" | "TCP" | "HTTP" | "HTTPS"} | The type of probe send by load balancer to verify member state | |||||||||||||||||||||||||||||||||||||||||||
| delay | Integer | Yes | CRU | None | non-negative | The time in seconds between sending probes to members. | |||||||||||||||||||||||||||||||||||||||||||
| timeout | uuid-str | Yes | CRU | None | non-negative | The maximum number of seconds for a monitor to wait for a connection to be established before it times out. The value must be less than the delay value. | |||||||||||||||||||||||||||||||||||||||||||
| max_retries | Integer | Yes | CRU | None | [1..10] | Number of allowed connection failures before changing the member's status to INACTIVE. | |||||||||||||||||||||||||||||||||||||||||||
| http_method | String | No[b] | CRU | GET | None | The HTTP method used for requests by the monitor. | |||||||||||||||||||||||||||||||||||||||||||
| url_path | String | No[b] | CRU | / | None | The HTTP path of the request sent by the monitor to test a member's health. This must be a string beginning with a / (forward slash). | |||||||||||||||||||||||||||||||||||||||||||
| expected_codes | String | No[b] | CRU | 200 | Single value, such as 200, list, such as 200, 202, or range, such as 200-204. | The list of HTTP status codes expected in response from the member to declare it healthy. | |||||||||||||||||||||||||||||||||||||||||||
| admin_state_up | Bool | No | CRU | true | {true | false } | Administrative state of the health monitor. | |||||||||||||||||||||||||||||||||||||||||||
| status | String | N/A | R | N/A | N/A | Indicates whether or not a health monitor is currently operational. | |||||||||||||||||||||||||||||||||||||||||||
[b] Required if | |||||||||||||||||||||||||||||||||||||||||||||||||
