Get load balancer pool

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

Python

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
load_balancer_pool = client.cloud.load_balancers.pools.get(
    pool_id="00000000-0000-4000-8000-000000000000",
    project_id=1,
    region_id=1,
)
print(load_balancer_pool.id)

200

{
  "admin_state_up": true,
  "ca_secret_id": "<string>",
  "creator_task_id": "d8334c12-2881-4c4a-84ad-1b21fea73ad1",
  "crl_secret_id": "<string>",
  "healthmonitor": {
    "admin_state_up": true,
    "delay": 10,
    "domain_name": "example.com",
    "http_method": "GET",
    "http_version": "1.1",
    "max_retries": 3,
    "max_retries_down": 3,
    "timeout": 5,
    "type": "HTTP",
    "url_path": "/"
  },
  "id": "9fccf0a3-c0de-441d-9afd-2b9b58b08b9f",
  "lb_algorithm": "ROUND_ROBIN",
  "listeners": [
    {
      "id": "c63341da-ea44-4027-bbf6-1f1939c783da"
    }
  ],
  "loadbalancers": [
    {
      "id": "79943b39-5e67-47e1-8878-85044b39667a"
    }
  ],
  "members": [
    {
      "address": "192.168.40.33",
      "admin_state_up": false,
      "backup": true,
      "id": "a7e7e8d6-0bf7-4ac9-8170-831b47ee2ba9",
      "monitor_address": null,
      "monitor_port": null,
      "operating_status": "ONLINE",
      "protocol_port": 80,
      "provisioning_status": "ACTIVE",
      "subnet_id": "32283b0b-b560-4690-810c-f672cbb2e28d",
      "weight": 1
    }
  ],
  "name": "my-pool",
  "operating_status": "ONLINE",
  "protocol": "TCP",
  "provisioning_status": "ACTIVE",
  "secret_id": "<string>",
  "session_persistence": {
    "cookie_name": "cookie_name",
    "persistence_granularity": "<string>",
    "persistence_timeout": 123,
    "type": "APP_COOKIE"
  },
  "task_id": null,
  "timeout_client_data": 50000,
  "timeout_member_connect": 50000,
  "timeout_member_data": null
}

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"

Response

200

application/json

Load balancer pool

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.

Examples:

true

false

ca_secret_id · string<uuid4> | null · required

Secret ID of CA certificate bundle

creator_task_id · string<uuid4> | null · required

Task that created this entity

Example:

"d8334c12-2881-4c4a-84ad-1b21fea73ad1"

crl_secret_id · string<uuid4> | null · required

Secret ID of CA revocation list file

healthmonitor · LbHealthMonitorSerializer · object | null · required

Health monitor parameters

Show child attributes

Example:

{
  "admin_state_up": true,
  "delay": 10,
  "domain_name": "example.com",
  "http_method": "GET",
  "http_version": "1.1",
  "max_retries": 3,
  "max_retries_down": 3,
  "timeout": 5,
  "type": "HTTP",
  "url_path": "/"
}

id · string<uuid4> · required

Pool ID

Example:

"9fccf0a3-c0de-441d-9afd-2b9b58b08b9f"

lb_algorithm · enum<string> · required

Load balancer algorithm

Available options: LEAST_CONNECTIONS, ROUND_ROBIN, SOURCE_IP

Example:

"ROUND_ROBIN"

listeners · MandatoryIdSchema schema · object[] · required

Listeners IDs

Show child attributes

Example:

[
  {
    "id": "c63341da-ea44-4027-bbf6-1f1939c783da"
  }
]

loadbalancers · MandatoryIdSchema schema · object[] · required

Load balancers IDs

Show child attributes

Example:

[
  {
    "id": "79943b39-5e67-47e1-8878-85044b39667a"
  }
]

members · DetailedLbPoolMemberSerializer · object[] · required · deprecated

Pool members. Deprecated. Use GET /v1/loadbalancers/{project_id}/{region_id}/pools/{pool_id}/members instead.

Show child attributes

name · string · required

Pool name

Pattern: ^[a-zA-Z0-9][a-zA-Z 0-9._\-]{1,61}[a-zA-Z0-9._]$

Example:

"my-pool"

operating_status · enum<string> · required

Pool operating status

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

Example:

"ONLINE"

protocol · enum<string> · required

Protocol

Available options: HTTP, HTTPS, PROXY, PROXYV2, TCP, UDP

Example:

"TCP"

provisioning_status · enum<string> · required

Pool lifecycle status

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

Example:

"ACTIVE"

secret_id · string<uuid4> | null · required

Secret ID for TLS client authentication to the member servers

session_persistence · LbSessionPersistence · object | null · required

Session persistence parameters

Show child attributes

task_id · string<uuid4> | null · 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.

Example:

null

timeout_client_data · integer | null · required · deprecated

Frontend client inactivity timeout in milliseconds

Required range: 0 <= x <= 86400000

Example:

50000

timeout_member_connect · integer | null · required

Backend member connection timeout in milliseconds

Required range: 0 <= x <= 86400000

Example:

50000

timeout_member_data · integer | null · required

Backend member inactivity timeout in milliseconds

Required range: 0 <= x <= 86400000

Example:

null