Sign in

v32

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

Get load balancer pool

get/cloud/v1/lbpools/{project_id}/{region_id}/{pool_id}

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

Response

OK

admin_state_upboolean 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.

ca_secret_idstring uuid4 nullable required

Secret ID of CA certificate bundle

creator_task_idstring uuid4 nullable required

Task that created this entity

crl_secret_idstring uuid4 nullable required

Secret ID of CA revocation list file

idstring uuid4 required

Pool ID

lb_algorithm'LEAST_CONNECTIONS' | 'ROUND_ROBIN' | 'SOURCE_IP' required
namestring required

Pool name

operating_status'DEGRADED' | 'DRAINING' | 'ERROR' | 'NO_MONITOR' | 'OFFLINE' | 'ONLINE' required
protocol'HTTP' | 'HTTPS' | 'PROXY' | 'PROXYV2' | 'TCP' | 'UDP' required
provisioning_status'ACTIVE' | 'DELETED' | 'ERROR' | 'PENDING_CREATE' | 'PENDING_DELETE' | 'PENDING_UPDATE' required
secret_idstring uuid4 nullable required

Secret ID for TLS client authentication to the member servers

task_idstring uuid4 nullable required

The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If null, the resource is not locked.

timeout_client_datainteger nullable required

Frontend client inactivity timeout in milliseconds

timeout_member_connectinteger nullable required

Backend member connection timeout in milliseconds

timeout_member_datainteger nullable required

Backend member inactivity timeout in milliseconds

Example response

{
  "admin_state_up": true,
  "creator_task_id": "d8334c12-2881-4c4a-84ad-1b21fea73ad1",
  "healthmonitor": {
    "delay": 10,
    "domain_name": "example.com",
    "expected_codes": "200,301,302",
    "http_version": "1.1",
    "id": "2eb5823b-9cdc-45cd-97c0-c95cc2278422",
    "max_retries": 2,
    "max_retries_down": 3,
    "timeout": 5,
    "url_path": "/"
  },
  "id": "9fccf0a3-c0de-441d-9afd-2b9b58b08b9f",
  "listeners": [
    {
      "id": "c63341da-ea44-4027-bbf6-1f1939c783da"
    }
  ],
  "loadbalancers": [
    {
      "id": "79943b39-5e67-47e1-8878-85044b39667a"
    }
  ],
  "members": [
    {
      "address": "192.168.40.33",
      "backup": true,
      "id": "a7e7e8d6-0bf7-4ac9-8170-831b47ee2ba9",
      "protocol_port": 80,
      "subnet_id": "32283b0b-b560-4690-810c-f672cbb2e28d",
      "weight": 1
    }
  ],
  "name": "lbaas_test_pool",
  "session_persistence": {
    "cookie_name": "cookie_name"
  },
  "timeout_client_data": 50000,
  "timeout_member_connect": 50000
}