Skip to main content
GET
Get load balancer pool member

Authorizations

​
Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234_abcdef

Path Parameters

​
project_id
integer
required

Project ID

Example:

1

​
region_id
integer
required

Region ID

Example:

1

​
pool_id
string<uuid4>
required

Pool ID

Example:

"00000000-0000-4000-8000-000000000000"

​
member_id
string<uuid4>
required

Member ID

Example:

"00000000-0000-4000-8000-000000000000"

Response

200 - application/json

OK

​
address
string<ipvanyaddress>
required

Member IP address

Example:

"192.168.40.33"

​
admin_state_up
boolean
required

Administrative state of the resource. When set to true, the resource is enabled and operational. When set to false, the resource is disabled and will not process traffic. Defaults to true.

Example:

false

​
backup
boolean
required

Set to true if the member is a backup member, to which traffic will be sent exclusively when all non-backup members will be unreachable. It allows to realize ACTIVE-BACKUP load balancing without thinking about VRRP and VIP configuration. Default is false

Examples:

true

false

​
id
string<uuid4>
required

Member ID must be provided if an existing member is being updated

Example:

"a7e7e8d6-0bf7-4ac9-8170-831b47ee2ba9"

​
monitor_address
string<ipvanyaddress> | null
required

An alternate IP address used for health monitoring of a backend member. Default is null which monitors the member address.

Example:

null

​
monitor_port
integer | null
required

An alternate protocol port used for health monitoring of a backend member. Default is null which monitors the member protocol_port.

Required range: 1 <= x <= 65535
Example:

null

​
operating_status
enum<string>
required

Member operating status of the entity

Available options:
DEGRADED,
DRAINING,
ERROR,
NO_MONITOR,
OFFLINE,
ONLINE
Examples:

"ONLINE"

"DRAINING"

"OFFLINE"

"DEGRADED"

"ERROR"

"NO_MONITOR"

​
protocol_port
integer
required

Member IP port

Required range: 1 <= x <= 65535
Example:

80

​
provisioning_status
enum<string>
required

Pool member lifecycle status

Available options:
ACTIVE,
DELETED,
ERROR,
PENDING_CREATE,
PENDING_DELETE,
PENDING_UPDATE
Example:

"ACTIVE"

​
subnet_id
string<uuid4> | null
required

subnet_id in which address is present.

Example:

"32283b0b-b560-4690-810c-f672cbb2e28d"

​
weight
integer
required

Member weight. Valid values are 0 < weight <= 256, defaults to 1. Controls traffic distribution based on the pool's load balancing algorithm:

  • ROUND_ROBIN: Distributes connections to each member in turn according to weights. Higher weight = more turns in the cycle. Example: weights 3 vs 1 = ~75% vs ~25% of requests.
  • LEAST_CONNECTIONS: Sends new connections to the member with fewest active connections, performing round-robin within groups of the same normalized load. Higher weight = allowed to hold more simultaneous connections before being considered 'more loaded'. Example: weights 2 vs 1 means 20 vs 10 active connections is treated as balanced.
  • SOURCE_IP: Routes clients consistently to the same member by hashing client source IP; hash result is modulo total weight of running members. Higher weight = more hash buckets, so more client IPs map to that member. Example: weights 2 vs 1 = roughly two-thirds of distinct client IPs map to the higher-weight member.
Required range: x <= 256
Example:

1