Pool

Media Type
[application/vnd.org.midonet.Pool-v1+json]
Condition Media Type
[application/vnd.org.midonet.collection.Pool-v1+json]
GET     /pools
GET     /load_balancers/:loadBalancerId/pools
GET     /healh_monitors/:healthMonitorId/pools
GET     /pools/:poolId
POST    /pools
POST    /load_balancers/:loadBalancerId/pools
PUT     /pools/:poolId
DELETE  /pools/:poolId

A pool is an entity that represents a group of backend load balancer addresses in MidoNet. It contains the following fields:

Field NameTypePOST/PUTRequiredDescription

uri

URI

  

A GET against this URI refreshes the representation of this resource.

healthMonitor

URI

  

A GET against this URI returns the health monitor for this pool.

loadBalancer

URI

  

A GET against this URI returns the load balancer for this pool.

poolMembers

URI

  

A GET against this URI returns the list of pool members.

vips

URI

  

A GET against this URI returns the list of VIPs associated with the pool.

id

UUID

POST

No

A unique identifier of the resource. If this field is omitted in the POST request, a random UUID is generated.

loadBalancerId

UUID

POST/PUT

Yes

The identifier of the load balancer corresponding to the pool. When using the /pools API end-point to create a pool, this field is used to determine the load balancer to which the pool belongs. When using the /load_balancers/:loadBalancerId/pools API end-point, this field is mandatory but its value will be ignored.

lbMethod

String

POST/PUT

Yes

The load balancing algorithm. Only ROUND_ROBIN is supported.

protocol

String

POST/PUT

No

The protocol used in the load balancing. Only TCP is supported.

adminStateUp

Boolean

POST/PUT

No

The administrative state of the pool. The default is true (up).

healthMonitorId

UUID

POST/PUT

No

The identifier of the health monitor to monitor the members of the pool.

status

String

  

The pool status. It can be one of the following: ACTIVE or INACTIVE.

Questions? Discuss on Mailing Lists or Chat.
Found an error? Report a bug.