Patch load balancer pool

Changes provided here will overwrite existing load balancer pool settings. Undefined fields will be kept as is. Complex objects need to be specified fully, they will be overwritten.

PATCH /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
)
task_id_list = client.cloud.load_balancers.pools.update(
    pool_id="00000000-0000-4000-8000-000000000000",
    project_id=1,
    region_id=1,
)
print(task_id_list.tasks)

200

{
  "tasks": [
    "<string>"
  ]
}

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"

Body

application/json

ca_secret_id · string<uuid4> | null

Secret ID of CA certificate bundle

crl_secret_id · string<uuid4> | null

Secret ID of CA revocation list file

healthmonitor · PatchLbHealthMonitorSerializer · object

New pool health monitor settings

Show child attributes

lb_algorithm · enum<string>

New load balancer pool algorithm of how to distribute requests

Available options: LEAST_CONNECTIONS, ROUND_ROBIN, SOURCE_IP

Example:

"ROUND_ROBIN"

members · CreateLbPoolMemberSerializer · object[] | null

New sequence of load balancer pool members. If members are the same (by address + port), they will be kept as is without recreation and downtime.

Show child attributes

Example:

[
  {
    "address": "192.168.40.33",
    "id": "a7e7e8d6-0bf7-4ac9-8170-831b47ee2ba9",
    "operating_status": "NO_MONITOR",
    "protocol_port": 80,
    "subnet_id": "32283b0b-b560-4690-810c-f672cbb2e28d",
    "weight": 1
  }
]

name · string

New pool name

Example:

"new_pool_name"

protocol · enum<string>

New communication protocol

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

Example:

"HTTP"

secret_id · string<uuid4> | null

Secret ID for TLS client authentication to the member servers

session_persistence · MutateLbSessionPersistence · object

New session persistence settings

Show child attributes

timeout_client_data · integer | null

Frontend client inactivity timeout in milliseconds

Required range: 0 <= x <= 86400000

Example:

50000

timeout_member_connect · integer | null

Backend member connection timeout in milliseconds

Required range: 0 <= x <= 86400000

Example:

50000

timeout_member_data · integer | null

Backend member inactivity timeout in milliseconds

Required range: 0 <= x <= 86400000

Example:

0

Response

200 - application/json

OK

tasks · string[] · required

List of task IDs

Example:

["d478ae29-dedc-4869-82f0-96104425f565"]