PoolMember

Media Type
[application/vnd.org.midonet.PoolMember-v1+json]
Collection Media Type
[application/vnd.org.midonet.collection.PoolMember-v1+json]
GET      /pool_members
GET      /load_balancers/:loadBalancerId/pools/:poolId/pool_members
GET      /pool_members/:poolMemberId
POST     /pool_members
POST     /load_balancers/:loadBalancerId/pools/:poolId/pool_members
PUT      /pool_members/:poolMemberId
DELETE   /pool_members/:poolMemberId

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

Field NameTypePOST/PUTRequiredDescription

uri

URI

  

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

pool

URI

  

A GET against this URI returns 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.

address

String

POST/PUT

Yes

The IP address of the pool member.

poolId

UUID

POST/PUT

Yes

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

protocolPort

Integer

POST/PUT

Yes

The protocol port of the pool member. The value must belong to the interval [0, 65535].

adminStateUp

Boolean

POST/PUT

No

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

weight

Integer

POST/PUT

No

The weight used for random algorithm. The default it 1.

status

String

  

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

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