Sign in

v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB
Load Balancers

Create load balancer pool member

post/cloud/v1/lbpools/{project_id}/{region_id}/{pool_id}/member

Path parameters

project_idinteger required

Project ID

Example:1

Project ID

region_idinteger required

Region ID

Example:1

Region ID

pool_idstring uuid4 required

Pool ID

Example:00000000-0000-4000-8000-000000000000

Pool ID

Request body

addressstring ipvanyaddress required

Member IP address

admin_state_upboolean

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.

backupboolean

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.

instance_idstring uuid4 nullable

Either subnet_id or instance_id should be provided

monitor_addressstring ipvanyaddress nullable

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

monitor_portinteger nullable

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

protocol_portinteger required

Member IP port

subnet_idstring uuid4 nullable

subnet_id in which address is present. Either subnet_id or instance_id should be provided

weightinteger

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.

Example request

{
  "address": "192.168.40.33",
  "admin_state_up": true,
  "backup": true,
  "instance_id": "a7e7e8d6-0bf7-4ac9-8170-831b47ee2ba9",
  "protocol_port": 80,
  "subnet_id": "32283b0b-b560-4690-810c-f672cbb2e28d",
  "weight": 1
}

Response

OK

tasksstring[] required

List of task IDs representing asynchronous operations. Use these IDs to monitor operation progress:

  • GET /v1/tasks/{task_id} - Check individual task status and details Poll task status until completion (FINISHED/ERROR) before proceeding with dependent operations.
idstring required

Example response

{
  "tasks": [
    "d478ae29-dedc-4869-82f0-96104425f565"
  ]
}