PoolGroup

Description

API


    POST /api/poolgroup
    PUT /api/poolgroup/<key>
    DELETE /api/poolgroup/<key>
    GET /api/poolgroup
    GET /api/poolgroup/<key>

CLI


    configure poolgroup <key>
    show poolgroup <key>

Data

PoolGroup

uuid

Type
string
Category
required
Description
UUID of the pool group

name

Type
string
Category
required
Description
The name of the pool group.

members

Type
PoolGroupMember
Category
repeated
Description
Member details

priority_labels_ref

Type
Reference to PriorityLabels
Category
optional
Description
UUID of the priority labels. If not provided, pool group member priority label will be interpreted as a number with a larger number considered higher priority.

min_servers

Type
uint32
Category
optional
Description
The minimum number of servers to distribute traffic to.
Default
0

deployment_policy_uuid

Type
string
Category
optional
Description
When setup autoscale manager will automatically promote new pools into production when deployment goals are met.

fail_action

Type
FailAction
Category
optional
Description
Enable an action - Close Connection, HTTP Redirect, or Local HTTP Response - when a pool group failure happens. By default, a connection will be closed, in case the pool group experiences a failure.

created_by

Type
string
Category
optional
Description
Creator name

cloud_config_cksum

Type
string
Category
optional
Description
Checksum of cloud configuration for PoolGroup. Internally set by cloud connector

description

Type
string
Category
optional
Description

tenant_ref

Type
Reference to Tenant
Category
optional
Description

cloud_ref

Type
Reference to Cloud
Category
optional,readonly
Description
Default
/api/cloud?name=Default-Cloud

PoolGroupMember

pool_ref

Type
Reference to Pool
Category
required
Description
UUID of the pool

ratio

Type
uint32
Category
optional
Description
Ratio of selecting eligible pools in the pool group.
Default
1

priority_label

Type
string
Category
optional
Description
All pools with same label are treated similarly in a pool group. A pool with a higher priority is selected, as long as the pool is eligible or an explicit policy chooses a different pool.

deployment_state

Type
enum
Category
optional
Description
Pool deployment state used with the PG deployment policy
Choices
EVALUATION_IN_PROGRESS, IN_SERVICE, OUT_OF_SERVICE, EVALUATION_FAILED

FailAction

type

Type
enum
Category
required
Description
Enables a response to client when pool experiences a failure. By default TCP connection is closed.
Default
FAIL_ACTION_CLOSE_CONN
Choices
FAIL_ACTION_BACKUP_POOL, FAIL_ACTION_CLOSE_CONN, FAIL_ACTION_HTTP_LOCAL_RSP, FAIL_ACTION_HTTP_REDIRECT

redirect

Type
FailActionHTTPRedirect
Category
optional
Description
URL to redirect HTTP requests to when pool experiences a failure

local_rsp

Type
FailActionHTTPLocalResponse
Category
optional
Description
Local response to HTTP requests when pool experiences a failure

backup_pool

Type
FailActionBackupPool
Category
optional
Description
Backup Pool when pool experiences a failure

FailActionHTTPRedirect

protocol

Type
enum
Category
optional
Description
Default
HTTPS
Choices
HTTP, HTTPS

host

Type
string
Category
required
Description

path

Type
string
Category
optional
Description

query

Type
string
Category
optional
Description

status_code

Type
enum
Category
optional
Description
Default
HTTP_REDIRECT_STATUS_CODE_302
Choices
HTTP_REDIRECT_STATUS_CODE_302, HTTP_REDIRECT_STATUS_CODE_301, HTTP_REDIRECT_STATUS_CODE_307

FailActionHTTPLocalResponse

status_code

Type
enum
Category
optional
Description
Default
FAIL_HTTP_STATUS_CODE_503
Choices
FAIL_HTTP_STATUS_CODE_503, FAIL_HTTP_STATUS_CODE_200

file

Type
HTTPLocalFile
Category
optional
Description

HTTPLocalFile

content_type

Type
string
Category
required
Description
Mime-type of the content in the file.

file_content

Type
string
Category
required
Description
File content to used in the local HTTP response body.

FailActionBackupPool

backup_pool_ref

Type
Reference to Pool
Category
required
Description
Specifies the UUID of the Pool acting as backup pool.

References

Cloud PriorityLabels Tenant Pool

Sub Objects