Module create

Creates a pool for a load balancer.

The pool defines how requests should be balanced across the backend member servers.

This operation provisions a pool by using the configuration that you define in the request object. After the API validates the request and starts the provisioning process, the API returns a response object, which contains a unique ID.

In the response, the pool provisioning status is ACTIVE, PENDING_CREATE, or ERROR.

If the status is PENDING_CREATE, issue GET /v2/lbaas/pools/{pool_id} to view the progress of the provisioning operation. When the pool status changes to ACTIVE, the pool is successfully provisioned and is ready for further configuration.

At a minimum, you must specify these pool attributes:

Some attributes receive default values if you omit them from the request:

If the API cannot fulfill the request due to insufficient data or data that is not valid, the service returns the HTTP Bad Request (400) response code with information about the failure in the response body. Validation errors require that you correct the error and submit the request again.

Specifying a project_id is deprecated. The pool will inherit the project_id of the parent load balancer.

You can configure all documented features of the pool at creation time by specifying the additional elements or attributes in the request.

To create a pool, the parent load balancer must have an ACTIVE provisioning status.

SOURCE_IP_PORT algorithm is available from version 2.13.

Structs

Healthmonitor

Defines mandatory and optional attributes of a POST request.

HealthmonitorBuilder

Builder for Healthmonitor.

Members

Defines mandatory and optional attributes of a POST request.

MembersBuilder

Builder for Members.

Pool

Defines mandatory and optional attributes of a POST request.

PoolBuilder

Builder for Pool.

Request

RequestBuilder

Builder for Request.

SessionPersistence

A JSON object specifying the session persistence for the pool or null for no session persistence. See Pool Session Persistence. Default is null.

SessionPersistenceBuilder

Builder for SessionPersistence.

Enums

HealthmonitorBuilderError

Error type for HealthmonitorBuilder

HealthmonitorType

HttpMethod

LbAlgorithm

MembersBuilderError

Error type for MembersBuilder

PoolBuilderError

Error type for PoolBuilder

Protocol

RequestBuilderError

Error type for RequestBuilder

SessionPersistenceBuilderError

Error type for SessionPersistenceBuilder

Type