Get load balancer pool

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)

{
  "ca_secret_id": "<string>",
  "creator_task_id": "d8334c12-2881-4c4a-84ad-1b21fea73ad1",
  "crl_secret_id": "<string>",
  "healthmonitor": {
    "admin_state_up": true,
    "delay": 1073741824,
    "id": "<string>",
    "max_retries": 5,
    "max_retries_down": 5,
    "operating_status": "DEGRADED",
    "provisioning_status": "ACTIVE",
    "timeout": 123,
    "type": "HTTP",
    "expected_codes": "200,301,302",
    "http_method": "GET",
    "url_path": "/"
  },
  "id": "<string>",
  "lb_algorithm": "LEAST_CONNECTIONS",
  "listeners": [
    {
      "id": "<string>"
    }
  ],
  "loadbalancers": [
    {
      "id": "<string>"
    }
  ],
  "members": [
    {
      "address": "<string>",
      "admin_state_up": true,
      "backup": true,
      "id": "<string>",
      "operating_status": "DEGRADED",
      "protocol_port": 123,
      "provisioning_status": "ACTIVE",
      "subnet_id": "32283b0b-b560-4690-810c-f672cbb2e28d",
      "weight": 123,
      "monitor_address": null,
      "monitor_port": null
    }
  ],
  "name": "<string>",
  "operating_status": "DEGRADED",
  "protocol": "HTTP",
  "provisioning_status": "ACTIVE",
  "secret_id": "<string>",
  "session_persistence": {
    "type": "APP_COOKIE",
    "cookie_name": "cookie_name",
    "persistence_granularity": "<string>",
    "persistence_timeout": 123
  },
  "task_id": null,
  "timeout_client_data": 50000,
  "timeout_member_connect": 50000,
  "timeout_member_data": null
}

GET

cloud

lbpools

{project_id}

{region_id}

{pool_id}

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)

{
  "ca_secret_id": "<string>",
  "creator_task_id": "d8334c12-2881-4c4a-84ad-1b21fea73ad1",
  "crl_secret_id": "<string>",
  "healthmonitor": {
    "admin_state_up": true,
    "delay": 1073741824,
    "id": "<string>",
    "max_retries": 5,
    "max_retries_down": 5,
    "operating_status": "DEGRADED",
    "provisioning_status": "ACTIVE",
    "timeout": 123,
    "type": "HTTP",
    "expected_codes": "200,301,302",
    "http_method": "GET",
    "url_path": "/"
  },
  "id": "<string>",
  "lb_algorithm": "LEAST_CONNECTIONS",
  "listeners": [
    {
      "id": "<string>"
    }
  ],
  "loadbalancers": [
    {
      "id": "<string>"
    }
  ],
  "members": [
    {
      "address": "<string>",
      "admin_state_up": true,
      "backup": true,
      "id": "<string>",
      "operating_status": "DEGRADED",
      "protocol_port": 123,
      "provisioning_status": "ACTIVE",
      "subnet_id": "32283b0b-b560-4690-810c-f672cbb2e28d",
      "weight": 123,
      "monitor_address": null,
      "monitor_port": null
    }
  ],
  "name": "<string>",
  "operating_status": "DEGRADED",
  "protocol": "HTTP",
  "provisioning_status": "ACTIVE",
  "secret_id": "<string>",
  "session_persistence": {
    "type": "APP_COOKIE",
    "cookie_name": "cookie_name",
    "persistence_granularity": "<string>",
    "persistence_timeout": 123
  },
  "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

region_id

integer

required

Region ID

pool_id

string<uuid4>

required

Pool ID

Response

200 - application/json

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

required

Health monitor parameters

Show child attributes

healthmonitor.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. When null is passed, the value is skipped and defaults to true.

healthmonitor.delay

integer

required

The time, in seconds, between sending probes to members

Required range: 1 <= x <= 2147483647

healthmonitor.id

string<uuid4>

required

Health monitor ID

healthmonitor.max_retries

integer

required

Number of successes before the member is switched to ONLINE state

Required range: 1 <= x <= 10

healthmonitor.max_retries_down

integer

required

Number of failures before the member is switched to ERROR state

Required range: 1 <= x <= 10

healthmonitor.operating_status

enum<string>

required

Health Monitor operating status

Available options:

DEGRADED,

DRAINING,

ERROR,

NO_MONITOR,

OFFLINE,

ONLINE

healthmonitor.provisioning_status

enum<string>

required

Health monitor lifecycle status

Available options:

ACTIVE,

DELETED,

ERROR,

PENDING_CREATE,

PENDING_DELETE,

PENDING_UPDATE

healthmonitor.timeout

integer

required

The maximum time to connect. Must be less than the delay value

Required range: x <= 2147483

healthmonitor.type

enum<string>

required

Health monitor type. Once health monitor is created, cannot be changed.

Available options:

HTTP,

HTTPS,

K8S,

PING,

TCP,

TLS-HELLO,

UDP-CONNECT

healthmonitor.expected_codes

string | null

Expected HTTP response codes. Can be a single code or a range of codes. Can only be used together with HTTP or HTTPS health monitor type. For example, 200,202,300-302,401,403,404,500-504. If not specified, the default is 200.

Example:

"200,301,302"

healthmonitor.http_method

enum<string> | null

HTTP method

Available options:

CONNECT,

DELETE,

GET,

HEAD,

OPTIONS,

PATCH,

POST,

PUT,

TRACE

Example:

"GET"

healthmonitor.url_path

string | null

URL Path. Defaults to '/'

Minimum string length: 1

Example:

"/"

string<uuid4>

required

Pool ID

lb_algorithm

enum<string>

required

Load balancer algorithm

Available options:

LEAST_CONNECTIONS,

ROUND_ROBIN,

SOURCE_IP

listeners

MandatoryIdSchema schema · object[]

required

Listeners IDs

Show child attributes

listeners.id

string<uuid4>

required

Resource ID

loadbalancers

MandatoryIdSchema schema · object[]

required

Load balancers IDs

Show child attributes

loadbalancers.id

string<uuid4>

required

Resource ID

members

DetailedLbPoolMemberSerializer · object[]

required

Pool members

Show child attributes

members.address

string<ipvanyaddress>

required

Member IP address

members.admin_state_up

boolean

required

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

members.id

string<uuid4>

required

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

members.operating_status

enum<string>

required

Member operating status of the entity

Available options:

DEGRADED,

DRAINING,

ERROR,

NO_MONITOR,

OFFLINE,

ONLINE

members.protocol_port

integer

required

Member IP port

members.provisioning_status

enum<string>

required

Pool member lifecycle status

Available options:

ACTIVE,

DELETED,

ERROR,

PENDING_CREATE,

PENDING_DELETE,

PENDING_UPDATE

members.subnet_id

string<uuid4> | null

required

subnet_id in which address is present.

Example:

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

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

members.monitor_address

string<ipvanyaddress> | null

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

Example:

null

members.monitor_port

integer | null

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

Example:

null

name

string

required

Pool name

operating_status

enum<string>

required

Pool operating status

Available options:

DEGRADED,

DRAINING,

ERROR,

NO_MONITOR,

OFFLINE,

ONLINE

protocol

enum<string>

required

Protocol

Available options:

HTTP,

HTTPS,

PROXY,

PROXYV2,

TCP,

UDP

provisioning_status

enum<string>

required

Pool lifecycle status

Available options:

ACTIVE,

DELETED,

ERROR,

PENDING_CREATE,

PENDING_DELETE,

PENDING_UPDATE

secret_id

string<uuid4> | null

required

Secret ID for TLS client authentication to the member servers

session_persistence

LbSessionPersistence · object

required

Session persistence parameters

Show child attributes

session_persistence.type

enum<string>

required

Session persistence type

Available options:

APP_COOKIE,

HTTP_COOKIE,

SOURCE_IP

Should be set if app cookie or http cookie is used

Example:

"cookie_name"

session_persistence.persistence_granularity

string | null

Subnet mask if source_ip is used. For UDP ports only

session_persistence.persistence_timeout

integer | null

Session persistence timeout. For UDP ports only

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

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

Update load balancer pool Delete load balancer pool

⌘I

Overview

IAM

CDN

Managed DNS

Cloud

DDoS Protection

FastEdge

WAAP

Streaming

Object Storage

Resellers

Get load balancer pool

Authorizations

Path Parameters

Response