The load balancer object describes the load balancer entity and contains additional information regarding the distribution of traffic across a network.
- Extends:
_entity
Attributes
Section titled “Attributes”code
- Type:
integer_t - Requirement: recommended
The numeric response status code detailing the connection from the load balancer to the destination target.
dst_endpoint
- Type:
network_endpoint - Requirement: recommended
The destination to which the load balancer is distributing traffic.
endpoint_connections
- Type:
endpoint_connection - Requirement: recommended
An object detailing the load balancer connection attempts and responses.
name
- Type:
string_t - Requirement: recommended
The name of the load balancer.
uid
- Type:
string_t - Requirement: recommended
The unique identifier for the load balancer.
classification
- Type:
string_t - Requirement: optional
The request classification as defined by the load balancer.
error_message
- Type:
string_t - Requirement: optional
The load balancer error message.
ip
- Type:
ip_t - Requirement: optional
The IP address of the load balancer node that handled the client request. Note: the load balancer may have other IP addresses, and this is not an IP address of the target/distribution endpoint - see dst_endpoint.
message
- Type:
string_t - Requirement: optional
The load balancer message.
metrics
- Type:
metric - Requirement: optional
General purpose metrics associated with the load balancer.
status_detail
- Type:
string_t - Requirement: optional
The status detail contains additional status information about the load balancer distribution event.
Constraints
Section titled “Constraints”At least one of: name, uid