LoadBalancer

From Ocean Framework Documentation Wiki
Jump to: navigation, search

The LoadBalancer resource has one public URI. (For information about the difference between Public and Internal URLs and HATEOAS conventions, please see API Structure and Conventions.)

/v1/load_balancers

Structure

All attributes are read only.

load_balancer_name
(String) The name of the load balancer.
dns_name
(String)
canonical_hosted_zone_name
(String)
canonical_hosted_zone_name_id
(String)
listener_descriptions
(Array) E.g.: [{"listener": {"protocol": "HTTP", "load_balancer_port": 80, "instance_protocol": "HTTP", "instance_port": 80}, "policy_names": []}, {"listener": {"protocol": "HTTPS", "load_balancer_port": 443, "instance_protocol": "HTTP", "instance_port:" 80, "ssl_certificate_id": "..."}, "policy_names": ["..."]}].
policies
(Array) E.g.: {"app_cookie_stickiness_policies": [], "lb_cookie_stickiness_policies": [], "other_policies": ["...", "..."]}.
backend_server_descriptions
(Array) E.g.: [].
availability_zones
(Array) The AWS availability zones. E.g.: ["eu-west-1b", "eu-west-1c", "eu-west-1a"].
subnets
(Array) The AWS subnets. E.g.: ["subnet-a6c21fc4", "subnet-ee871ab8"].
vpc_id
(String) The AWS VPC id.
instances
(Array) E.g.: [{"instance_id": "i-35fe908d"}, {"instance_id": "i-40f9f3f9"}].
health_check
(Object) E.g.: {"target": "HTTP:80/ping", "interval": 30, "timeout": 5, "unhealthy_threshold": 2, "healthy_threshold": 10}.
source_security_group
(Object) E.g.: {"owner_alias": "9690035944237", "group_name": "default"}.
security_groups
(Array) E.g.: ["sg-980f5bfa"].
created_at
(String) A datetime string in GMT.
scheme
(String) E.g.: "internet-facing".
metrics
(Object) CloudWatch metrics for the past hour. Metric name strings are keys pointing to a chronologically sorted array of values. The latest data point is at the end of each array. The following metrics are gathered: HealthyHostCount, UnHealthyHostCount, RequestCount, Latency, SurgeQueueLength, SpilloverCount, HTTPCode_ELB_4XX, HTTPCode_ELB_5XX, HTTPCode_Backend_2XX, HTTPCode_Backend_3XX, HTTPCode_Backend_4XX, HTTPCode_Backend_5XX, BackendConnectionErrors. For each metric, the statistics gathered are Sum, Maximum, Minimum, Average. See LoadBalancer Metrics Format for an example of the exact format. (AWS docs are here.)

Hyperlinks

The following hyperlink names are used in the following subsections. To retrieve the URL and Content-Type to use, use the _links hash. Note that the URI may change, and thus you should make no inference on how to construct similar URIs from any previous URI. For more information, refer to Hyperlink URIs are Opaque. You may store hyperlink URIs in permanent storage for later use.

self
The self hyperlink can be used to retrieve the LoadBalancer resource via a GET. LoadBalancers are read-only.


GET self

Retrieves a LoadBalancer resource.

200
The operation was successful.

GET /v1/load_balancers

Retrieves all LoadBalancers.

200
The operation was successful.

GET /v1/load_balancers/<name>

Retrieves the LoadBalancer with the given load_balancer_name.

200
The operation was successful.