Skip to main content
GET
/
cloud
/
v1
/
lbpools
/
{project_id}
/
{region_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_list = client.cloud.load_balancers.pools.list(
    project_id=1,
    region_id=1,
)
print(load_balancer_pool_list.count)
{
  "count": 1,
  "results": [
    {
      "ca_secret_id": "<string>",
      "creator_task_id": "d8334c12-2881-4c4a-84ad-1b21fea73ad1",
      "crl_secret_id": "<string>",
      "healthmonitor": {
        "delay": 10,
        "http_method": "GET",
        "max_retries": 3,
        "max_retries_down": 3,
        "timeout": 5,
        "type": "HTTP",
        "url_path": "/"
      },
      "id": "<string>",
      "lb_algorithm": "LEAST_CONNECTIONS",
      "listeners": [
        {
          "id": "<string>"
        }
      ],
      "loadbalancers": [
        {
          "id": "<string>"
        }
      ],
      "members": [
        {
          "id": "<string>"
        }
      ],
      "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

Example:

1

​
region_id
integer
required

Region ID

Example:

1

Query Parameters

​
details
boolean
default:false

Show members and Health Monitor details

Examples:

true

false

​
listener_id
string<uuid4>

Listener ID

Example:

"00000000-0000-4000-8000-000000000000"

​
loadbalancer_id
string<uuid4>

Load Balancer ID

Example:

"00000000-0000-4000-8000-000000000000"

Response

200 - application/json

OK

​
count
integer
required

Number of objects

Required range: x >= 0
Example:

1

​
results
LbPoolSerializer · object[]
required

Objects