Load Balancer

load_balancer

The load balancer object describes the load balancer entity and contains additional information regarding the distribution of traffic across a network.

Contents

Attributes

Caption Name Type Is Array Default Description
Classification classification String The request classification as defined by the load balancer.
Response Code code Integer The numeric response status code detailing the connection from the load balancer to the destination target.
Destination Endpoint dst_endpoint Network Endpoint The destination to which the load balancer is distributing traffic.
Endpoint Connections endpoint_connections Endpoint Connection An object detailing the load balancer connection attempts and responses.
Error Message error_message String The load balancer error message.
Message message String The load balancer message.
Metrics metrics Metric General purpose metrics associated with the load balancer.
Name name String The name of the load balancer.
Raw Data raw_data JSON The event data as received from the event source.
Record ID record_id String Unique identifier for the object
Status Detail status_detail String The status detail contains additional status information about the load balancer distribution event.
Unique ID uid String The unique identifier for the load balancer.
Unmapped Data unmapped Unmapped The attributes that are not mapped to the event schema. The names and values of those attributes are specific to the event source.

Context

Load Balancer

JSON

            
{
  "caption": "Load Balancer",
  "name": "load_balancer",
  "extends": "_entity",
  "description": "The load balancer object describes the load balancer entity and contains additional information regarding the distribution of traffic across a network.",
  "attributes": {
    "metrics": {
      "caption": "Metrics",
      "description": "General purpose metrics associated with the load balancer.",
      "is_array": true,
      "requirement": "optional",
      "type": "metric"
    },
    "dst_endpoint": {
      "caption": "Destination Endpoint",
      "description": "The destination to which the load balancer is distributing traffic.",
      "requirement": "recommended",
      "type": "network_endpoint"
    },
    "code": {
      "caption": "Response Code",
      "description": "The numeric response status code detailing the connection from the load balancer to the destination target.",
      "requirement": "recommended",
      "type": "integer_t"
    },
    "endpoint_connections": {
      "caption": "Endpoint Connections",
      "description": "An object detailing the load balancer connection attempts and responses.",
      "requirement": "recommended",
      "is_array": true,
      "type": "endpoint_connection"
    },
    "classification": {
      "caption": "Classification",
      "description": "The request classification as defined by the load balancer.",
      "requirement": "optional",
      "type": "string_t"
    },
    "status_detail": {
      "caption": "Status Detail",
      "description": "The status detail contains additional status information about the load balancer distribution event.",
      "requirement": "optional",
      "type": "string_t"
    },
    "error_message": {
      "caption": "Error Message",
      "description": "The load balancer error message.",
      "requirement": "optional",
      "type": "string_t"
    },
    "message": {
      "caption": "Message",
      "description": "The load balancer message.",
      "requirement": "optional",
      "type": "string_t"
    },
    "name": {
      "description": "The name of the load balancer.",
      "requirement": "recommended",
      "caption": "Name",
      "type": "string_t"
    },
    "uid": {
      "description": "The unique identifier for the load balancer.",
      "requirement": "recommended",
      "caption": "Unique ID",
      "type": "string_t"
    },
    "raw_data": {
      "group": "context",
      "caption": "Raw Data",
      "description": "The event data as received from the event source.",
      "type": "json_t"
    },
    "record_id": {
      "description": "Unique identifier for the object",
      "group": "primary",
      "requirement": "required",
      "caption": "Record ID",
      "type": "string_t"
    },
    "unmapped": {
      "caption": "Unmapped Data",
      "description": "The attributes that are not mapped to the event schema. The names and values of those attributes are specific to the event source.",
      "type": "unmapped",
      "is_array": true
    }
  },
  "constraints": {
    "at_least_one": [
      "name",
      "uid"
    ]
  }
}