Neutron/LBaaS/API 1.0

= OpenStack LBaaS API 1.0 (draft) =

Intended Audience
Intended Audience

This guide is for software developers who create applications by using the LBaaS API v1.0. To use this information, you should have a general understanding of the OpenStack LBaaS service, the OpenStack Quantum service, and the integration between the two. You should also know how to obtain authentication tokens from the OpenStack KeyStone service.

You should also be familiar with:


 * ReSTful web services
 * HTTP/1.1
 * JSON serialization format

Document Change History
This version of the Developer Guide replaces and obsoletes all previous versions. The most recent changes are described in the table below:

Resources
Use the following resources in conjunction with this guide:

Chapter 1. Overview
The LBaaS project provides a load balancing service to enable OpenStack tenants to load balance traffic to their VMs.

Th capabilities provided by the LBaaS service are:


 * Load balancing client traffic coming from one network to application services (e.g. VMs) present on the same or a different network.
 * Supporting load balancing for several protocols
 * Supporting session persistence
 * Monitoring the health of the application services
 * Protecting the application services against Denial of Service (DoS) attacks
 * Collecting traffic statistics on the incoming client traffic.

High-Level Task Flow
The high-level task flow for using LBaaS API to configure load balancing is as follows:


 * The tenant creates a Pool, which is initially empty
 * The tenant creates one or several Members in the Pool
 * The tenant create one or several Health Monitors
 * The tenant associates the Health Monitors with the Pool
 * The tenant finally creates a VIP with the Pool

Concepts
To use OpenStack LBaaS APIs effectively, you should understand several key concepts:

VIP
A VIP is the primary load balancing configuration object that specifies the virtual IP address and port on which client traffic is received, as well as other details such as the load balancing method to be use, protocol, etc. This entity is sometimes known in LB products under the name of a "virtual server", a "vserver" or a "listener".

#!wiki caution Note

In the tradional load balancing vernacular, the term 'VIP' is used to denote the IP address to which clients connect. As it is defined in this document, this IP address is only one attribute of the VIP object.

Pool
A load balancing pool is a logical set of devices, such as web servers, that you group together to receive and process traffic. The load balancing function chooses a member of the pool according to the configured load balancing method to handle the new requests or connections received on the VIP address. There is only one pool for a VIP.

Pool Member
A pool member represents the application running on backend server.

Health Monitoring
A health monitor is used to determine whether or not back-end members of the VIP's pool are usable for processing a request. A pool can have several health monitors associated with it. There are different types of health monitors supported by the OpenStack LBaaS service:


 * PING: used to ping the members using ICMP.
 * TCP: used to connect to the members using TCP.
 * HTTP: used to send an HTTP request to the member.
 * HTTPS: used to send a secure HTTP request to the member.

When a pool has several monitors associated with it, each member of the pool is monitored by all these monitors. If any monitor declares the member as unhealthy, then the member status is changed to INACTIVE and the member won't participate in its pool's load balancing. In other words, ALL monitors must declare the member to be healthy for it to stay ACTIVE.

Session Persistence
Session persistence is a feature of the load balancing service. It attempts to force connections or requests in the same session to be processed by the same member as long as it is ative. The OpenStack LBaaS service supports three types of persistence:


 * SOURCE_IP: With this persistence mode, all connections originating from the same source IP address, will be handled by the same member of the pool.
 * HTTP_COOKIE: With this persistence mode, the load balancing function will create a cookie on the first request from a client. Subsequent requests containing the same cookie value will be handled by the same member of the pool.
 * APP_COOKIE: With this persistence mode, the load balancing function will rely on a cookie established by the backend application. All requests carrying the same cookie value will be handled by the same member of the pool.

Connection Limits
To control incoming traffic on the VIP address as well as traffic for each member of a pool, you can set a connection limit on the VIP or on the pool, beyond which the load balancing function will refuse client requests or connections. This can be used to thwart DoS attacks and to allow each member of the pool to continue to work within its limits.

For HTTP and HTTPS protocols, since several HTTP requests can be multiplexed on the same TCP connection, the connection limit value is interpreted as the maximum number of requests allowed.

Chapter 2. General API Information
Sections in this chapter describe operations and guidelines that are common to all OpenStack APIs, and are not specific to the Load Balancing API.

Authentication and Authorization
The LBaaS API v1.0 uses the Keystone Identity Service as the default authentication service. When Keystone is enabled, users that submit requests to the LBaaS service must provide an authentication token in X-Auth-Token request header. You obtain the token by authenticating to the Keystone endpoint. For more information about Keystone, see the OpenStack Identity Developer Guide.

Users with non-admin roles, can only perform CRUD (Create, Retrieve, Update and Delete) operations on the resources they own. Users with admin roles (as configured in the Keystone service) can operate on other tenant resources by specifying a "tenant_id" attribute in the resource's representation when creating or updating, and by specifying a "tenant_id" query string when retrieving or deleting.

LBaaS uses information received from Keystone to authorize user requests. LBaaS handles the following types of authorization policies:

Operation-based policies

Specify access criteria for specific operations, possibly with fine-grained control over specific attributes.

Resource-based policies

Access a specific resource. Permissions might or might not be granted depending on the permissions configured for the resource.

Request/Response Types
The LBaaS API v1.0 supports the JSON data serialization format. This means that for requests that contain a body, the Content-Type header must be set to the MIME type value "application/json". Also, clients should accept JSON serialized responses by specifying the Accept header with the MIME type value "application/json" or adding ".json" extension to the resource name. The default response format is "application/json" if the client omits to specify an Accept header or append the ".json" extension in the URL path.

Example:

#!highlight javascript numbers=disable GET /v1.0/vips.json

or

#!highlight javascript numbers=disable GET /v1.0/vips Accept: application/json

Filtering and Column Selection
The LBaaS API v1.0 supports filtering based on all top level attributes of a resource. Filters are applicable to all list requests.

For example, the following request returns all VIPs named foobar:

#!highlight javascript numbers=disable GET /v1.0/vips?name=foobar

When you specify multiple filters, the LBaaS API v1.0 returns only objects that meet all filtering criteria. The operation applies an AND condition among the filters.

#!wiki caution Note

LBaaS does not offer an OR mechanism for filters.

Alternatively, you can issue a distinct request for each filter and build a response set from the received responses on the client-side.

By default, the LBaaS service returns all attributes for any show or list call. The LBaaS API v1.0 has a mechanism to limit the set of attributes returned. You can use the fields query parameter to control the attributes returned from the LBaaS API v1.0.

For example, the following request returns only id,name,subnet_id,address and protocol_port for each vip:

#!highlight javascript numbers=disable GET /v1.0/vips.json?fields=id&fields=name&fields=subnet_id&fields=address&fields=protocol_port

Synchronous versus Asynchronous Plugin Behavior
The LBaaS API v1.0 presents a logical load balancing configuration consisting of vips, pools, and members. It is up to the LBaaS plugin to communicate with the underlying infrastructure to ensure load balancing is consistent with the logical model. A plugin might perform these operations asynchronously.

When an API client modifies the logical model by issuing an HTTP POST, PUT, or DELETE request, the API call might return before the plugin modifies underlying virtual and physical load balancing function. However, an API client is guaranteed that all subsequent API calls properly reflect the changed logical model.

For example, if a client issues an HTTP POST request on the members resource to add a new member to a pool, there is no guarantee that the member can receive traffic when the HTTP call returns. However, it is guaranteed that a subsequent HTTP GET request to view the members on the pool returns a list that would contain the added member.

You can use the status attribute of the VIP, the Pool, the pool Member or the Health Monitor to determine whether the LBaaS plugin has successfully completed the configuration of the resource.

'''Table 4.1. Status Values '''

When status is set to "ERROR" in an object returned by the LBaaS service, then the returned object might also contain an extra attribute called "error_details" which provides textual explanation on the error, its cause, and possibly a way for the user to remedy the situation.

Update Operations
The update operations of resources use the HTTP PUT method with "patch" semantics (as opposed to "replace" semantics), meaning that the attributes submitted in the PUT request are changed on the resource while the attributes that haven't been submitted in the update operation keep their previous values in the resource.

Also, note that not all attributes of a resource can be updated. This is described in the "update" operation on each resource.

Quotas
[tbd]

Notifications
[tbd]

Extensions
The LBaaS API v1.0 is extensible.

The purpose of LBaaS API v1.0 extensions is to:


 * Introduce new features in the API without requiring a version change.
 * Introduce vendor-specific niche functionality.
 * Act as a proving ground for experimental functionalities that might be included in a future version of the API.

To programmatically determine which extensions are available, issue a GET request on the /v1.0/extensions URI.

To query extensions individually by unique alias, issue a GET request on the /v1.0/extensions/alias_name URI. Use this method to easily determine if an extension is available. If the extension is not available, a 404 Not Found response is returned.

You can extend existing core API resources with new actions or extra attributes. Also, you can add new resources as extensions. Extensions usually have tags that prevent conflicts with other extensions that define attributes or resources with the same names, and with core resources and attributes. Because an extension might not be supported by all plugins, the availability of an extension varies with deployments and the specific plugin in use. So, make sure that your extension is available on the deployed LBaaS service before making use of its extra features.

Faults
The LBaaS API v1.0 returns an error response if a failure occurs while processing a request. LBaaS uses only standard HTTP error codes. 4xx errors indicate problems in the particular request being sent from the client.

The response body will contain richer information about the cause of the error. An error response follows the format illustrated by the following example:

#!highlight javascript numbers=disable HTTP/1.1 409 Conflict Content-type: application/json Content-lentgh:78

{  "errorcode": 409, "errormessage": "pool 'cfc6589d-f949-4c66-99d2-c2da56ef3764' is already used by VIP 'db902c0c-d5ff-4753-b465-668ad9656918' " }

Chapter 3. API Operations
This chapter explains specific API operations. For ideas relevant to all API operations, see the "General API Information" chapter.

VIPs
Use the following APIs to manage vip resources

List all VIPs
Normal Response Code(s): 200

Error Response Code(s): 401 (Unauthorized), 500 (Internal server error), 503 (Service Unavailable)

This operation returns the list of all VIPs associated with your tenant account. If If you have an admin role, then this request returns all the VIPs of all tenants.

This operation does not require a request body.

This operation returns a response body. It returns a (potentially empty) list, each element in the list is a VIP that can contain the following attributes:


 * id
 * tenant_id
 * name
 * description
 * subnet_id
 * address
 * port_id
 * protocol_port
 * protocol
 * pool_id
 * session_persistence
 * connection_limit
 * admin_state_up
 * status

'''Example. List all VIPs'''

JSON Request:

#!highlight javascript numbers=disable GET /v1.0/vips Host: lbaas-service.cloudX.com:8651 Accept: application/json X-Auth-Token:887665443383838

JSON Response:

#!highlight javascript numbers=disable HTTP/1.1 200 OK Content-Type: application/json Content-Length: 384

{ "vips":[ {          "id": "db902c0c-d5ff-4753-b465-668ad9656918", "tenant_id": "310df60f-2a10-4ee5-9554-98393092194c", "name": "web_vip", "description": "lb config for the web tier", "subnet_id": "96a4386a-f8c3-42ed-afce-d7954eee77b3", "address" : "10.30.176.47", "port_id" : "cd1f7a47-4fa6-449c-9ee7-632838aedfea", "protocol": "HTTP", "protocol_port": 80, "pool_id" : "cfc6589d-f949-4c66-99d2-c2da56ef3764", "admin_state_up": true, "status": "ACTIVE" },        {           "id": "36e08a3e-a78f-4b40-a229-1e7e23eee1ab", "tenant_id": "310df60f-2a10-4ee5-9554-98393092194c", "name": "db_vip", "subnet_id": "9cedb85d-0759-4898-8a4b-fa5a5ea10086", "address" : "10.30.176.48", "port_id" : "cd1f7a47-4fa6-449c-9ee7-632838aedfea", "protocol": "TCP", "protocol_port": 3306, "pool_id" : "41efe233-7591-43c5-9cf7-923964759f9e", "session_persistence" : {"type" : "SOURCE_IP"}, "connection_limit" : 2000, "admin_state_up": true, "status": "INACTIVE" }     ] }

Retrieve a specific VIP
Normal Response Code(s): 200

Error Response Code(s): 401 (Unauthorized), 403 (Forbidden), 404 (Not Found), 409 (Conflict), 413 (Over limit), 500 (Internal server error), 503 (Service Unavailable)

This operation returns a VIP object identified by vip_id. If the user is not an admin, and the VIP object doesn't belong to her tenant account, she would receive a 403 (Forbidden) error.

This operation does not require a request body.

This operation returns a response body. On success, the returned element is a VIP that can contain the following attributes:


 * id
 * tenant_id
 * name
 * description
 * subnet_id
 * address
 * port_id
 * protocol_port
 * protocol
 * pool_id
 * session_persistence
 * connection_limit
 * admin_state_up
 * status

'''Example. Retrieve a VIP details: '''

JSON Request:

#!highlight javascript numbers=disable GET /v1.0/vips/36e08a3e-a78f-4b40-a229-1e7e23eee1ab Host: lbaas-service.cloudX.com:8651 Accept: application/json X-Auth-Token:887665443383838

JSON Response:

#!highlight javascript numbers=disable HTTP/1.1 200 OK Content-Type: application/json Content-Length: 156

{    "vip": { "id": "36e08a3e-a78f-4b40-a229-1e7e23eee1ab", "tenant_id": "310df60f-2a10-4ee5-9554-98393092194c", "name": "db_vip", "description": "lb config for the MYSQL db tier", "subnet_id": "9cedb85d-0759-4898-8a4b-fa5a5ea10086", "address" : "10.30.176.47", "port_id" : "cd1f7a47-4fa6-449c-9ee7-632838aedfea", "protocol": "TCP", "protocol_port": 3306, "pool_id" : "41efe233-7591-43c5-9cf7-923964759f9e", "session_persistence" : {"type" : "SOURCE_IP"}, "connection_limit" : 2000, "admin_state_up": true, "status": "INACTIVE" } }

Create a VIP
Normal Response Code(s): 202

Error Response Code(s): 401 (Unauthorized), 404 (Not Found), 409 (Conflict), 413 (Over limit), 500 (Internal server error), 503 (Service Unavailable)

This operation provisions a new VIP based on the configuration defined in the request object. Once the request is validated and progress has started on the provisioning process, a response object will be returned. The object will contain a unique identifier and the status of provisioning the VIP.

The status of the VIP in the response can take one of the following values: ACTIVE, PENDING_CREATE or ERROR.

If the status returned is set to "PENDING_CREATE", then using the identifier of the VIP, the caller can check on the progress of the provisioning operation by performing a GET on vips/vip_id. When the status of the vip returned changes to "ACTIVE", then the VIP has been successfully provisioned and is now operational for traffic handling.

The caller of this operation must specify at least the following attributes of the VIP:


 * name
 * tenant_id: only required if the caller has an admin role and wants to create a VIP for another tenant.
 * subnet_id: The network on which to allocate the vip's address. A tenant can only create vips on networks authorized by policy (e.g. her own networks or shared/provider networks).
 * protocol: the protocol of the vip address.
 * protocol_port: the port on which to listen for client traffic that is associated with the vip address.
 * pool_id: the id of the pool that contains the real servers to which traffic is load balanced.

Some attributes will receive default values if not specified in the request:


 * service_type: The service type used to create the VIP will be the default service type configured in the LBaaS Service.
 * admin_state_up: The default value for this attribute is true.

Also note that the pool_id should refer to a pool that is not already associated with another vip. If the pool is already used by another vip, then this creation operation will fail with a 409 Conflict error.

If the request cannot be fulfilled due to insufficient or invalid data, an HTTP 400 (Bad Request) error response will be returned with information regarding the nature of the failure in the body of the response. Failures in the validation process are non-recoverable and require the caller to correct the cause of the failure and POST the request again.

Users may configure all documented features of the VIP at creation time by simply providing the additional elements or attributes in the request.

Users with an admin role can create VIPs on behalf of other tenants by specifying a tenant_id attribute different than their own.

'''Example. Create a VIP '''

JSON Request:

#!highlight javascript numbers=disable POST /v1.0/vips Host: lbaas-service.cloudX.com:8651 Content-Type: application/json Accept: application/json X-Auth-Token:887665443383838 Content-Length: 463

{ "vip": { "tenant_id": "310df60f-2a10-4ee5-9554-98393092194c", "name": "web_vip", "subnet_id": "96a4386a-f8c3-42ed-afce-d7954eee77b3", "protocol": "HTTPS", "protocol_port": 443, "pool_id" : "cfc6589d-f949-4c66-99d2-c2da56ef3764", "session_persistence" : {"type":"APP_COOKIE", "cookie_name":"jsessionid"} } }

JSON Response:

#!highlight javascript numbers=disable HTTP/1.1 202 Accepted Content-Type: application/json Content-Length: 213

{ "vip": { "id": "02b1fef7-16f5-4917-bf19-c40a9af805ed", "tenant_id": "310df60f-2a10-4ee5-9554-98393092194c", "name": "web_vip", "subnet_id": "96a4386a-f8c3-42ed-afce-d7954eee77b3", "address" : "10.30.176.47", "port_id" : "cd1f7a47-4fa6-449c-9ee7-632838aedfea", "protocol": "HTTPS", "protocol_port": 443, "pool_id" : "cfc6589d-f949-4c66-99d2-c2da56ef3764", "session_persistence" : {"type":"APP_COOKIE", "cookie_name":"jsessionid"}, "admin_state_up": true, "status": "PENDING_CREATE" } }

A user can supply an address field if she owns the network on which the VIP will be created. If an address is not specified in the payload, then the LBaaS service will allocate one from the VIP's network.

Once an address is allocated to the user, the user can create other VIP objects using the same address but with different protocol ports.

'''Example. Create a VIP with an address shared with another VIP '''

JSON Request:

#!highlight javascript numbers=disable POST /v1.0/vips Host: lbaas-service.cloudX.com:8651 Content-Type: application/json Accept: application/json X-Auth-Token:887665443383838 Content-Length: 234

{ "vip": { "name": "ssl_vip", "subnet_id": "96a4386a-f8c3-42ed-afce-d7954eee77b3", "address" : "10.30.176.47", "protocol": "HTTPS", "protocol_port": 443, "pool_id" : "91c20e53-96cd-4476-8efc-627f398773bb" } }

JSON Response:

#!highlight javascript numbers=disable HTTP/1.1 202 Accepted Content-Type: application/json Content-Length: 282

{ "vip": { "id": "02b1fef7-16f5-4917-bf19-c40a9af805ed", "tenant_id": "310df60f-2a10-4ee5-9554-98393092194c", "name": "ssl_vip", "subnet_id": "96a4386a-f8c3-42ed-afce-d7954eee77b3", "address" : "10.30.176.47", "port_id" : "cd1f7a47-4fa6-449c-9ee7-632838aedfea", "protocol": "HTTPS", "protocol_port": 443, "pool_id" : "91c20e53-96cd-4476-8efc-627f398773bb", "session_persistence" : {"type":"APP_COOKIE", "cookie_name":"jsessionid"}, "admin_state_up": true, "status": "PENDING_CREATE" } }

Update a VIP
Normal Response Code(s): 202

Error Response Code(s): serviceFault (500), serviceUnavailable (503), unauthorized (401), badRequest (400), overLimit (413)

This operation updates the attributes of the specified VIP. Upon successful validation of the request, the service will return a 202 (Accepted) response code. A caller should check that the VIP status has changed to ACTIVE to confirm that the update has taken effect. If the VIP status is "PENDING_UPDATE" then the caller can poll the VIP object (using a GET operation) to wait for the changes to be applied.

The update operation allows the caller to change one or more of the following VIP attributes:


 * name
 * description
 * pool_id
 * session_persistence
 * connection_limit
 * admin_state_up

This operation returns the updated VIP object. The status of the VIP in the response can take one of the following values: ACTIVE, PENDING_UPDATE or ERROR.

#!wiki caution Note

The VIP's ID, status, subnet_id, address, protocol_port and protocol are immutable attributes and cannot be modified once a VIP is created. Supplying an unsupported attribute will result in a 422 (Immutable) fault.

#!wiki caution Note

A VIP that is pending deletion or has an ERROR status cannot be updated.

'''Example. updating a VIP '''

JSON Request:

#!highlight javascript numbers=disable PUT /v1.0/vips/02b1fef7-16f5-4917-bf19-c40a9af805ed Host: lbaas-service.cloudX.com:8651 Content-Type: application/json Accept: application/json X-Auth-Token:887665443383838 Content-Length: 75

{ "vip": { "name": "ssl_vip_1", "description": "this VIP is used for secure web connections", "session_persistence": { "type": "HTTP_COOKIE" } } }

JSON Response:

#!highlight javascript numbers=disable HTTP/1.1 202 Accepted Content-Type: application/json Content-Length: 282

{ "vip": { "id": "02b1fef7-16f5-4917-bf19-c40a9af805ed", "tenant_id": "310df60f-2a10-4ee5-9554-98393092194c", "name": "ssl_vip_1", "subnet_id": "96a4386a-f8c3-42ed-afce-d7954eee77b3", "address" : "10.30.176.47", "port_id" : "cd1f7a47-4fa6-449c-9ee7-632838aedfea", "protocol": "HTTPS", "protocol_port": 443, "pool_id" : "cfc6589d-f949-4c66-99d2-c2da56ef3764", "session_persistence": { "type": "HTTP_COOKIE" }, "admin_state_up": true, "status": "PENDING_UPDATE" } }

Remove a VIP
Normal Response Code(s): 204

Error Response Code(s): serviceFault (500), serviceUnavailable (503), unauthorized (401), badRequest (400), overLimit (413)

This operation removes the specified VIP and its associated configuration from the tenant account. Any and all configuration data is immediately purged and is not recoverable.

This operation does not require a request body.

This operation does not return a response body.

'''Example. Deleting a VIP '''

JSON Request:

#!highlight javascript numbers=disable DELETE /v1.0/vips/02b1fef7-16f5-4917-bf19-c40a9af805ed Host: lbaas-service.cloudX.com:8651 Accept: application/json X-Auth-Token:887665443383838

JSON Response:

#!highlight javascript numbers=disable HTTP/1.1 204 No Content

Pools
A Pool is a container of a set of members to which the traffic is load-balanced. The pool construct is a way to share several configuration attributes between members that belong to the same pool. For example protocol and health monitors are configured on the pool, and all members of the same pool, will be monitored using these health monitors.

#!wiki caution Note

Each VIP object can be associated with one pool. Also a pool cannot be used by more than one VIP object. It needs to be first removed from one VIP in order to be added to another.

List all Pools
List all pools of a tenant.

Normal Response Code(s): 200

Error Response Code(s): serviceFault (500), serviceUnavailable (503), unauthorized (401), badRequest (400), overLimit (413)

This operation does not require a request body.

This operation returns a response body. On success, the returned element is a (potentially empty) list, each element is a Pool object which can contain the following attributes:


 * id
 * tenant_id
 * vip_id
 * name
 * description
 * subnet_id
 * protocol
 * lb_method
 * members
 * health_monitors
 * admin_state_up
 * status

'''Example. List pools Request:'''

JSON Request:

#!highlight javascript numbers=disable GET /v1.0/pools.json Host: lbaas-service.cloudX.com:8651 X-Auth-Token:887665443383838

'''Example. List pools Response: JSON'''

#!highlight javascript numbers=disable HTTP/1.1 200 OK Content-Type: application/json Content-Length: 628

{ "pools" : [ {               "id":"cfc6589d-f949-4c66-99d2-c2da56ef3764", "tenant_id": "310df60f-2a10-4ee5-9554-98393092194c", "vip_id": "db902c0c-d5ff-4753-b465-668ad9656918", "name": "web_pool", "protocol": "HTTP", "lb_method": "ROUND_ROBIN", "subnet_id" : "e2a7a228-8fd1-4aa8-8d0c-4023a68e1c92", "members" : [ "c57f581b-c834-408f-93fa-30543cf30618", "f2e37304-e3c1-4f96-9201-dd57a16adb75", "cd701b32-7f55-4e8b-94a0-756cd85a684d" ],               "health_monitors" : [ "954171e2-8816-4d59-a9d5-c85310b4508d" ],               "admin_state_up" : true, "status" : "ACTIVE" },             {                "id":"91c20e53-96cd-4476-8efc-627f398773bb", "tenant_id": "310df60f-2a10-4ee5-9554-98393092194c", "vip_id": "02b1fef7-16f5-4917-bf19-c40a9af805ed", "protocol": "HTTPS", "subnet_id" : "e2a7a228-8fd1-4aa8-8d0c-4023a68e1c92", "lb_method" : "LEAST_CONNECTIONS", "members" : [ "fcbf4e80-2fc7-4c7a-8a2e-8ea929620df9", "6ea4761c-f571-4ec8-a6ae-6a4baf7e49d", "26c49527-999c-4ef5-9484-5c065414d3db" ],               "health_monitors" : [ "3b4ee887-fff5-4e45-ac55-c34ee599061a" ],               "admin_state_up" : true, "status" : "ACTIVE" },             {                "id":"41efe233-7591-43c5-9cf7-923964759f9e", "tenant_id": "310df60f-2a10-4ee5-9554-98393092194c", "vip_id": "36e08a3e-a78f-4b40-a229-1e7e23eee1ab", "protocol": "TCP", "subnet_id" : "ddc3ab81-1dac-4be3-a340-c7b7b5d89beb", "lb_method": "ROUND_ROBIN", "members" : [ "a24a6159-fc0f-4f42-ab10-5fe8763fef6e", "8c65956d-8f3c-41a4-abc3-5311eb3b4ba9" ],               "health_monitors" : [ "65479d91-36f4-4651-89c2-2daee22a3c78", "441d3298-bf31-4c3b-8433-7e93a7a3db16" ],               "admin_state_up" : true, "status" : "ACTIVE" }           ] }

Retrieve a specific Pool
This operation retrieves the configuration of a pool.

Normal Response Code(s): 200

Error Response Code(s): serviceFault (500), serviceUnavailable (503), unauthorized (401), badRequest (400), overLimit (413)

This operation does not require a request body.

This operation returns a response body. On success, the returned Pool object can contain the following attributes:


 * id
 * tenant_id
 * vip_id
 * name
 * description
 * subnet_id
 * protocol
 * lb_method
 * members
 * health_monitors
 * admin_state_up
 * status

Note that only attributes that have a value are returned in the response. For example if the pool is not associated with a vip, the vip_id attribute is not returned in the response payload.

'''Example. Retrieve the configuration of a pool '''

JSON Request:

#!highlight javascript numbers=disable GET /v1.0/pools/cfc6589d-f949-4c66-99d2-c2da56ef3764 Host: lbaas-service.cloudX.com:8651 Accept: application/json X-Auth-Token:887665443383838

'''Example. List pools Response: JSON'''

#!highlight javascript numbers=disable HTTP/1.1 200 OK Content-Type: application/json Content-Length: 628

{ "pool" : { "id":"cfc6589d-f949-4c66-99d2-c2da56ef3764", "tenant_id": "310df60f-2a10-4ee5-9554-98393092194c", "vip_id": "db902c0c-d5ff-4753-b465-668ad9656918", "name": "web_pool", "protocol": "HTTP", "lb_method": "ROUND_ROBIN", "subnet_id" : "e2a7a228-8fd1-4aa8-8d0c-4023a68e1c92", "members" : [ "c57f581b-c834-408f-93fa-30543cf30618", "f2e37304-e3c1-4f96-9201-dd57a16adb75", "cd701b32-7f55-4e8b-94a0-756cd85a684d" ],        "health_monitors" : [ "f784c3a7-c4e8-44da-bf12-5ff417d27555" ],        "admin_state_up" : true, "status" : "ACTIVE" } }

Create a Pool
Normal Response Code(s): 202

Error Response Code(s): serviceFault (500), serviceUnavailable (503), unauthorized (401), badRequest (400), overLimit (413)

When a pool is added, it is assigned a unique identifier which can be used for querying, changing or deleting it.

If a user has an admin role, she can create pools for other tenant by specifying the tenant_id attribute in the request payload.

The caller of this operation must specify at least the following attributes of the Pool:


 * tenant_id: only required if the caller has an admin role and wants to create a pool for another tenant.
 * name: name of the pool
 * subnet_id: The network on which the members of the pool will be located. Only members that are on this network can be added to the pool.
 * lb_method: The algorithm used to distribute load between the members of the pool. The current specification supports "ROUND_ROBIN" and "LEAST_CONNECTIONS" as valid values for this attribute.
 * protocol: The protocol used by the pool members

The status of the Pool in the response can take one of the following values: ACTIVE, PENDING_CREATE or ERROR.

'''Example. Creating a pool '''

JSON Request:

#!highlight javascript numbers=disable POST /v1.0/pools Host: lbaas-service.cloudX.com:8651 Accept: application/json Content-Type: application/json X-Auth-Token:887665443383838 Content-Length: 194

{ "pool" : { "name": "web_pool", "protocol": "HTTP", "lb_method" : "ROUND_ROBIN", "subnet_id" : "e2a7a228-8fd1-4aa8-8d0c-4023a68e1c92", } }

JSON Response

#!highlight javascript numbers=disable HTTP/1.1 202 Accepted Content-Type: application/json Content-Length: 275

{ "pool" : { "id":"cfc6589d-f949-4c66-99d2-c2da56ef3764", "tenant_id": "310df60f-2a10-4ee5-9554-98393092194c", "name": "web_pool", "protocol": "HTTP", "subnet_id" : "e2a7a228-8fd1-4aa8-8d0c-4023a68e1c92", "lb_method": "ROUND_ROBIN", "admin_state_up" : true, "status" : "PENDING_CREATE" } }

Update a Pool
Normal Response Code(s): 202

Error Response Code(s): serviceFault (500), serviceUnavailable (503), unauthorized (401), badRequest (400), overLimit (413)

The caller of this operation may update the following attributes of the Pool:


 * name
 * description
 * lb_method
 * admin_state_up

The status of the Pool in the response can take one of the following values: ACTIVE, PENDING_UPDATE or ERROR.

#!wiki caution Note

A Pool that is pending to be deleted (status="PENDING_DELETE") or has a "ERROR" status cannot be updated.

'''Example. Update the name of the pool'''

JSON Request:

#!highlight javascript numbers=disable PUT /v1.0/pools/cfc6589d-f949-4c66-99d2-c2da56ef3764 Host: lbaas-service.cloudX.com:8651 Accept: application/json Content-Type: application/json X-Auth-Token:887665443383838 Content-Length: 194

{ "pool" : { "name": "web_pool_1" } }

JSON Response

#!highlight javascript numbers=disable HTTP/1.1 202 Accepted Content-Type: application/json Content-Length: 269

{ "pool" : { "id":"cfc6589d-f949-4c66-99d2-c2da56ef3764", "tenant_id": "310df60f-2a10-4ee5-9554-98393092194c", "vip_id": "db902c0c-d5ff-4753-b465-668ad9656918", "name": "web_pool_1", "protocol": "HTTP", "subnet_id" : "e2a7a228-8fd1-4aa8-8d0c-4023a68e1c92", "lb_method": "ROUND_ROBIN", "members" : [ "c57f581b-c834-408f-93fa-30543cf30618", "f2e37304-e3c1-4f96-9201-dd57a16adb75" ],           "admin_state_up" : true, "status" : "PENDING_UPDATE" } }

Remove a Pool
Normal Response Code(s): 204

Error Response Code(s): serviceFault (500), serviceUnavailable (503), unauthorized (401), badRequest (400), overLimit (413)

This operation does not require a request body.

This operation does not return a response body.

#!wiki caution Note

Attempting to remove a pool that is used in a VIP will result in a badRequest (400) error. First remove the pool from the VIP, then you can destroy the pool and its members.

'''Example. Removing a pool'''

JSON Request:

#!highlight javascript numbers=disable DELETE /v1.0/pools/cfc6589d-f949-4c66-99d2-c2da56ef3764 Host: lbaas-service.cloudX.com:8651 Accept: application/json X-Auth-Token:887665443383838

JSON Response

#!highlight javascript numbers=disable HTTP/1.1 204 No Content

Pool Members
The members of a pool are responsible for servicing the requests received through the vip's virtual IP. The load-balancing method is used to distribute requests or connections between the pool members.

The weight of a member determines the portion of requests or connections it services compared to the other members of the pool. For example, if member A has a weight of 2 and member B has a weight of 1, then member A will service twice as many requests as member B. If the weight attribute is not specified, then the member's weight is implicitly set to "1".

List all Members
List all members of all pools for a tenant.

Normal Response Code(s): 200

Error Response Code(s): serviceFault (500), serviceUnavailable (503), unauthorized (401), badRequest (400), overLimit (413)

This operation does not require a request body.

This operation returns a response body. On success, the returned response is a (potentially empty) list, each element in the list is a Member object can contain the following attributes:


 * id
 * tenant_id
 * pool_id
 * address
 * protocol_port
 * weight
 * admin_state_up
 * status

'''Example. Listing all members '''

JSON Request:

#!highlight javascript numbers=disable GET /v1.0/members Host: lbaas-service.cloudX.com:8651 Accept: application/json X-Auth-Token:887665443383838

JSON Response:

#!highlight javascript numbers=disable HTTP/1.1 200 OK Content-Type: application/json Content-Length: 917

{ "members" : [ {               "id":"c57f581b-c834-408f-93fa-30543cf30618", "tenant_id": "310df60f-2a10-4ee5-9554-98393092194c", "pool_id": "cfc6589d-f949-4c66-99d2-c2da56ef3764", "address": "192.168.224.31", "protocol_port": 8080, "weight" : 1, "admin_state_up" : true, "status" : "ACTIVE" },             {                "id":"f2e37304-e3c1-4f96-9201-dd57a16adb75", "tenant_id": "310df60f-2a10-4ee5-9554-98393092194c", "pool_id": "cfc6589d-f949-4c66-99d2-c2da56ef3764", "address": "192.168.224.32", "protocol_port" : 8081, "weight": 2, "admin_state_up" : true, "status" : "ACTIVE" },             {                "id":"cd701b32-7f55-4e8b-94a0-756cd85a684d", "tenant_id": "310df60f-2a10-4ee5-9554-98393092194c", "pool_id": "cfc6589d-f949-4c66-99d2-c2da56ef3764", "address": "192.168.224.35" "protocol_port": 8080, "weight" : 1, "admin_state_up" : false, "status" : "INACTIVE" },             {                "id":"fcbf4e80-2fc7-4c7a-8a2e-8ea929620df9", "tenant_id": "310df60f-2a10-4ee5-9554-98393092194c", "pool_id": "91c20e53-96cd-4476-8efc-627f398773bb", "address": "192.168.137.61", "protocol_port": 8443, "weight" : 1, "admin_state_up" : true, "status" : "ACTIVE" },             {                "id":"6ea4761c-f571-4ec8-a6ae-6a4baf7e49d", "tenant_id": "310df60f-2a10-4ee5-9554-98393092194c", "pool_id": "91c20e53-96cd-4476-8efc-627f398773bb", "address": "192.168.137.62", "protocol_port": 8443, "weight" : 1, "admin_state_up" : true, "status" : "ACTIVE" },             {                "id":"26c49527-999c-4ef5-9484-5c065414d3db", "tenant_id": "310df60f-2a10-4ee5-9554-98393092194c", "pool_id": "91c20e53-96cd-4476-8efc-627f398773bb", "address": "192.168.137.63", "protocol_port": 8443, "weight" : 1, "admin_state_up" : true, "status" : "ACTIVE" },             {                "id":"a24a6159-fc0f-4f42-ab10-5fe8763fef6e", "tenant_id": "310df60f-2a10-4ee5-9554-98393092194c", "pool_id": "41efe233-7591-43c5-9cf7-923964759f9e", "address": "192.168.200.114", "protocol_port": 3306, "weight" : 1, "admin_state_up" : true, "status" : "ACTIVE" },             {                "id":"8c65956d-8f3c-41a4-abc3-5311eb3b4ba9", "tenant_id": "310df60f-2a10-4ee5-9554-98393092194c", "pool_id": "41efe233-7591-43c5-9cf7-923964759f9e", "address": "192.168.200.132", "protocol_port": 3306, "weight" : 1, "admin_state_up" : true, "status" : "INACTIVE" }           ] }

Retrieve a specific Member
This operation retrieves the configuration of a member.

Normal Response Code(s): 200

Error Response Code(s): serviceFault (500), serviceUnavailable (503), unauthorized (401), badRequest (400), overLimit (413)

This operation does not require a request body.

This operation returns a response body. On success, the returned response is a Member object which can contain the following attributes:


 * id
 * tenant_id
 * pool_id
 * address
 * protocol_port
 * weight
 * admin_state_up
 * status

'''Example. Retrieve the configuration of a pool member '''

JSON Request:

#!highlight javascript numbers=disable GET /v1.0/members/c57f581b-c834-408f-93fa-30543cf30618 Host: lbaas-service.cloudX.com:8651 Accept: application/json X-Auth-Token:887665443383838

JSON Response:

#!highlight javascript numbers=disable HTTP/1.1 200 OK Content-Type: application/json Content-Length: 917

{ "member" :  { "id":"c57f581b-c834-408f-93fa-30543cf30618", "tenant_id": "310df60f-2a10-4ee5-9554-98393092194c", "pool_id": "cfc6589d-f949-4c66-99d2-c2da56ef3764", "address": "192.168.224.31", "protocol_port": 8080, "weight" : 1, "admin_state_up" : true, "status" : "ACTIVE" } }

Create Pool Members
Normal Response Code(s): 202

Error Response Code(s): serviceFault (500), serviceUnavailable (503), unauthorized (401), badRequest (400), overLimit (413)

When a member is created, it is assigned a unique identifier that can be used for mutating operations such as changing the admin_state or the weight of a member, or removing the member from the pool.

The caller of this operation must specify at least the following attributes of the Pool:


 * tenant_id: only required if the caller has an admin role and wants to create a pool for another tenant.
 * address: the IP address of the pool member on the pool's network.
 * protocol_port: The port on which the pool member listens for requests or connections.
 * pool_id: The pool to which the member belongs.

The status of the Member in the response can take one of the following values: ACTIVE, PENDING_CREATE or ERROR.

#!wiki caution Note:

When a member is added to a pool, it is enabled by default (admin_state_up = true) unless admin_state_up was set to false.

'''Example. Create a member '''

In this example, we add the first 2 members to one pool and the third member to a second pool.

JSON Request:

#!highlight javascript numbers=disable POST /v1.0/members Host: lbaas-service.cloudX.com:8651 Accept: application/json Content-Type: application/json X-Auth-Token:887665443383838 Content-Length: 826 {     "member" : { "address": "192.168.224.31", "protocol_port": 8080, "pool_id": "cfc6589d-f949-4c66-99d2-c2da56ef3764" } }

JSON Response:

#!highlight javascript numbers=disable HTTP/1.1 202 Accepted Content-Type: application/json Content-Length: 917

{ "member" : { "id":"c57f581b-c834-408f-93fa-30543cf30618", "tenant_id": "310df60f-2a10-4ee5-9554-98393092194c", "pool_id": "cfc6589d-f949-4c66-99d2-c2da56ef3764", "address": "192.168.224.31", "protocol_port": 8080, "weight" : 1, "admin_state_up" : true, "status" : "PENDING_CREATE"

} }

Update a Member
Normal Response Code(s): 202

Error Response Code(s): serviceFault (500), serviceUnavailable (503), unauthorized (401), badRequest (400), overLimit (413)

The caller of this operation may update the following attributes of the Member:


 * pool_id
 * weight
 * admin_state_up

The status of the Member in the response can take one of the following values: ACTIVE, PENDING_UPDATE or ERROR.

#!wiki caution Note

The member's address and protocol_port are immutable attributes and cannot be modified with a PUT request. Supplying an unsupported attribute will result in a 400 (badRequest) fault. A pool supports a maximum number of members. The maximum number of members per pool is returned when querying the limits of the LBaaS service.

#!wiki caution Note

A pool member that is pending deletion or has an ERROR status cannot be updated.

Every member in the pool is either enabled or disabled which determines its role within the pool using the admin_state_up attribute. When the member has admin_state_up=true, the member is permitted to accept new connections or requests. Its status will eventually become ACTIVE to reflect this configuration. When the member has admin_state_up=false, the member is not permitted to accept any new connections or requests regardless of session persistence configuration. Existing connections to the member are gracefully drained or forcibly terminated. The member's status changes to INACTIVE once the configuration has been successfully applied.

'''Example. Disable a pool member '''

JSON Request:

#!highlight javascript numbers=disable PUT /v1.0/members/c57f581b-c834-408f-93fa-30543cf30618 Host: lbaas-service.cloudX.com:8651 Accept: application/json Content-Type: application/json X-Auth-Token:887665443383838 Content-Length: 826

{ "member" :  { "admin_state_up": false } }

JSON Response:

#!highlight javascript numbers=disable HTTP/1.1 202 ACCEPTED Content-Type: application/json Content-Length: 917

{ "member" : { "id":"c57f581b-c834-408f-93fa-30543cf30618", "tenant_id": "310df60f-2a10-4ee5-9554-98393092194c", "pool_id": "cfc6589d-f949-4c66-99d2-c2da56ef3764", "address": "192.168.224.31", "protocol_port": 8080, "weight" : 1, "admin_state_up" : false, "status" : "PENDING_UPDATE" } }

Remove a Member
Normal Response Code(s): 204

Error Response Code(s): serviceFault (500), serviceUnavailable (503), unauthorized (401), badRequest (400), overLimit (413)

This operation does not require a request body.

This operation does not return a response body.

'''Example. remove a member from its pool '''

JSON Request:

#!highlight javascript numbers=disable DELETE /v1.0/members/c57f581b-c834-408f-93fa-30543cf30618 Host: lbaas-service.cloudX.com:8651 Accept: application/json X-Auth-Token:887665443383838

JSON RESPONSE

#!highlight javascript numbers=disable HTTP/1.1 204 No Content

Health Monitors
Normal Response Code(s): 200, 202, 204

Error Response Code(s): serviceFault (500), serviceUnavailable (503), unauthorized (401), badRequest (400), overLimit (413)

Active health monitoring provides 3 types of health monitors. The caller can configure one health monitor on the load blancer.

The health monitor has a type attribute to signify which of the 3 types it is. The 3 types available in this specification are described below.

'''Table 4.4. Health Monitor Types'''

The required attributes to specify when creating a health monitor depend on the health monitor type.

Create a Health Monitor
Normal Response Code(s): 202

Error Response Code(s): serviceFault (500), serviceUnavailable (503), unauthorized (401), badRequest (400), overLimit (413)

Create a PING Health Monitor
The monitor pings the member to ensure that the member is alive.

The PING monitor is the most basic type of health check. The following configurable properties must be specified:


 * delay: This is the minimum time in seconds between regular pings of the member.
 * timeout: Maximum number of seconds for a monitor to wait for a ping reply before it times out. The value must be less than the delay value.
 * max_retries: Number of permissible ping failures before changing the member's status to INACTIVE. Must be a number between 1 and 10.

The status of the Health Monitor in the response can take one of the following values: ACTIVE, PENDING_CREATE or ERROR.

'''Example. Monitor PING'''

JSON Request:

#!highlight javascript numbers=disable POST /v1.0/health_monitors Host: lbaas-service.cloudX.com:8651 Accept: application/json Content-Type: application/json X-Auth-Token:887665443383838 Content-Length: 91

{   "health_monitor" : {        "type" : "PING", "delay" : 20, "timeout": 10, "max_retries": 3 } }

JSON Response:

#!highlight javascript numbers=disable HTTP/1.1 202 Accepted Content-Type: application/json Content-Length: 114

{   "health_monitor" : {        "id" : "f784c3a7-c4e8-44da-bf12-5ff417d27555", "type" : "PING", "delay" : 20, "timeout": 10, "max_retries": 3, "admin_state_up": true, "status": "PENDING_CREATE" } }

Create a TCP Health Monitor
A TCP monitor tries to establish a TCP connection to the member to ensure that the member is healthy.

The following configurable properties must be specified for a TCP monitor:


 * delay: This is the minimum time in seconds between regular connections of the member.
 * timeout: 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: Number of permissible connection failures before changing the member's status to INACTIVE. Must be a number between 1 and 10.

The status of the Health Monitor in the response can take one of the following values: ACTIVE, PENDING_CREATE or ERROR.

'''Example. Create a TCP Monitor'''

JSON Request:

#!highlight javascript numbers=disable POST /v1.0/health_monitors Host: lbaas-service.cloudX.com:8651 Accept: application/json Content-Type: application/json X-Auth-Token:887665443383838 Content-Length: 91

{   "health_monitor" : {        "type" : "TCP", "delay" : 20, "timeout": 10, "max_retries": 3 } }

JSON Response:

#!highlight javascript numbers=disable HTTP/1.1 202 Accepted Content-Type: application/json Content-Length: 114

{   "health_monitor" : {        "id" : "e5069610-744b-42a7-8bd8-ceac1a229cd4", "type" : "TCP", "delay" : 20, "timeout": 10, "max_retries": 3, "admin_state_up": true, "status": "PENDING_CREATE"

} }

Create an HTTP or an HTTPS Health Monitor
The HTTP and HTTPS monitor is more intelligent than the TCP monitor. It is capable of processing an HTTP or HTTPS response to determine the condition of a member. It supports the same basic properties as the TCP monitor and includes the additional attribute of path  that is used to evaluate the HTTP response to a monitor probe.

attribute can contain one value, or a list of values separated by comma, or a range of values (e.g. "200-299"). If this attribute is not specified, it defaults to "200".
 * http_method: The HTTP method used for requests by the monitor. If this attribute is not specified, it defaults to "GET".
 * url_path: The HTTP path used in the HTTP request used by the monitor to test a member's health. This must be a string beginning with a / (forward slash). If this is not specified it defaults to "/".
 * expected_codes: These are the list of HTTP status codes expected in response from the member to declare it healthy. This

The status of the Health Monitor in the response can take one of the following values: ACTIVE, PENDING_CREATE or ERROR.

'''Example. Create a HTTP Monitor '''

JSON Request:

#!highlight javascript numbers=disable POST /v1.0/health_monitors Host: lbaas-service.cloudX.com:8651 Accept: application/json Content-Type: application/json X-Auth-Token:887665443383838 Content-Length: 91

{   "health_monitor" : {        "type" : "HTTP", "delay" : 20, "timeout": 10, "max_retries": 3, "http_method" : "HEAD", "path" : "/check", "expected_codes" : "200-299" } }

JSON Response:

#!highlight javascript numbers=disable HTTP/1.1 202 Accepted Content-Type: application/json Content-Length: 114

{   "health_monitor" : {        "id" : "f3eeab00-8367-4524-b662-55e64d4cacb5", "type" : "HTTP", "delay" : 20, "timeout": 10, "max_retries": 3, "http_method" : "GET", "url_path" : "/", "expected_codes" : "200,202", "admin_state_up": true, "status": "PENDING_CREATE" } }

Update a Health Monitor
All the attributes of a Health Monitor can be updated apart from the type attribute which is immutable.

The status of the Health Monitor in the response can take one of the following values: ACTIVE, PENDING_UPDATE or ERROR.

#!wiki caution Note

A Health Monitor that is pending deletion or has an ERROR status cannot be updated.

The following example illustrate how to update a Health Monitor.

'''Example. Update a TCP Monitor'''

JSON Request:

#!highlight javascript numbers=disable PUT /v1.0/health_monitors/e5069610-744b-42a7-8bd8-ceac1a229cd4 Host: lbaas-service.cloudX.com:8651 Accept: application/json Content-Type: application/json X-Auth-Token:887665443383838 Content-Length: 41

{   "health_monitor" : {        "delay" : 30, "max_retries": 2 } }

JSON Response:

#!highlight javascript numbers=disable HTTP/1.1 202 Accepted Content-Type: application/json Content-Length: 114

{   "health_monitor" : {        "id" : "e5069610-744b-42a7-8bd8-ceac1a229cd4", "type" : "TCP", "delay" : 30, "timeout": 10, "max_retries": 2, "admin_state_up": true, "status": "PENDING_UPDATE" } }

Delete a Health Monitor
When a health monitor is deleted, it is automatically dissociated from all the pools where it is used.

'''Example. Delete a TCP Monitor'''

JSON Request:

#!highlight javascript numbers=disable DELETE /v1.0/health_monitors/e5069610-744b-42a7-8bd8-ceac1a229cd4 Host: lbaas-service.cloudX.com:8651 Accept: application/json X-Auth-Token:887665443383838

JSON Response:

#!highlight javascript numbers=disable HTTP/1.1 204 No Content

List all Health Monitors
This operation returns a response body. On success, the returned response is a (potentially empty) list, each element in the list is a Health Monitor object that can contain the following attributes:


 * id
 * type
 * delay
 * timeout
 * max_retries
 * admin_state_up
 * status

In addition, if the type of the Health Monitor is HTTP or HTTPS, the following attributes are also present:


 * http_method
 * url_path
 * expected_codes

'''Example. List all health monitors accessible to this tenant '''

JSON Request:

#!highlight javascript numbers=disable GET /v1.0/health_monitors Host: lbaas-service.cloudX.com:8651 Accept: application/json X-Auth-Token:887665443383838

JSON Response:

#!highlight javascript numbers=disable HTTP/1.1 200 OK Content-Type: application/json Content-Length: 114

{  "health_monitors" : [ {                        "id" : "e5069610-744b-42a7-8bd8-ceac1a229cd4", "type" : "TCP", "delay" : 30, "timeout": 10, "max_retries": 2, "admin_state_up": true, "status": "ACTIVE" },                       {                          "id" : "f3eeab00-8367-4524-b662-55e64d4cacb5", "type" : "HTTP", "delay" : 20, "timeout": 10, "max_retries": 3, "http_method" : "GET", "url_path" : "/check", "expected_codes" : "200,202", "admin_state_up": true, "status": "PENDING_CREATE" }                ] }

Associate Health Monitors with a Pool
You can associate a health monitor with an existing pool. Once associated, the health monitor will start monitoring the members of the pool and will deactivate these members if they are deemed unhealthy. A member can be disactivated (status set to INACTIVE) if any of health monitors finds it unhealthy.

The response will return the current list of all health monitors associated with the pool.

'''Example. Add a health monitor to the monitors for a pool'''

JSON Request:

#!highlight javascript numbers=disable POST /v1.0/pools/cfc6589d-f949-4c66-99d2-c2da56ef3764/health_monitors Host: lbaas-service.cloudX.com:8651 Accept: application/json X-Auth-Token:887665443383838

{   "id" : "f3eeab00-8367-4524-b662-55e64d4cacb5" }

JSON Response:

#!highlight javascript numbers=disable HTTP/1.1 202 Accepted Content-Type: application/json Content-Length: 114

{   "id" : "f784c3a7-c4e8-44da-bf12-5ff417d27555", }

Note that the pool status will change to PENDING_UPDATE while the association is processed. A pool status of ACTIVE indicates that the change has successfully taken place.

Dissociate Health Monitors from a Pool
you can dissociate a health monitor from a pool. When dissociation is successful, the health monitor will no longer check for the health of the members of the pool.

Note that the pool status will change to PENDING_UPDATE while the dissociation is processed. A pool status of ACTIVE indicates that the change has successfully taken place.

'''Example. Dissociate a health monitor from a pool'''

JSON Request:

#!highlight javascript numbers=disable DELETE /v1.0/pools/cfc6589d-f949-4c66-99d2-c2da56ef3764/health_monitors/f3eeab00-8367-4524-b662-55e64d4cacb5 Host: lbaas-service.cloudX.com:8651 Accept: application/json X-Auth-Token:887665443383838

JSON Response:

#!highlight javascript numbers=disable HTTP/1.1 204 No Content

Retrieve Traffic Statistics for a Pool
Normal Response Code(s): 200

Error Response Code(s): serviceFault (500), serviceUnavailable (503), unauthorized (401), badRequest (400), overLimit (413)

This operation retrieves the aggregated traffic statistics for all members of a pool. The returned statistics are not necessarily real-time and might be collected in the background on a periodic basis and the cached data returned to the user during this call.

This operation does not require a request body.

The pool stats reports provide a set of stats counters. This list will contain at least the following counters:


 * bytes_in: The total number of bytes that pool members have received from clients.
 * bytes_out: The total number of bytes that pool members have sent to clients.
 * active_connections: The current number of active connections being served by the pool members.
 * total_connections: The total number of connections that have been processed by the pool members.

'''Example. Retrieve the stats for a pool'''

JSON Request:

#!highlight javascript numbers=disable GET /v1.0/pools/cfc6589d-f949-4c66-99d2-c2da56ef3764/stats Host: lbaas-service.cloudX.com:8651 Accept: application/json X-Auth-Token:887665443383838

JSON Response:

#!highlight javascript numbers=disable HTTP/1.1 200 OK Content-Type: application/json Content-Length: 114

{   "stats" : { "bytes_in" : 36839202, "bytes_out" : 673193022, "active_connections" : 39, "total_connections" : 682 } }