Skip to main content
GET
/
cloud
/
v1
/
loadbalancers
/
{project_id}
/
{region_id}
/
{load_balancer_id}
/
status
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_status = client.cloud.load_balancers.statuses.get(
    load_balancer_id="load_balancer_id",
    project_id=0,
    region_id=0,
)
print(load_balancer_status.id)
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "listeners": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "operating_status": "DEGRADED",
      "pools": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "members": [
            {
              "address": "<string>",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "operating_status": "DEGRADED",
              "protocol_port": 123,
              "provisioning_status": "ACTIVE"
            }
          ],
          "name": "<string>",
          "operating_status": "DEGRADED",
          "provisioning_status": "ACTIVE",
          "health_monitor": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "operating_status": "DEGRADED",
            "provisioning_status": "ACTIVE",
            "type": "HTTP"
          }
        }
      ],
      "provisioning_status": "ACTIVE"
    }
  ],
  "name": "<string>",
  "operating_status": "DEGRADED",
  "provisioning_status": "ACTIVE",
  "tags": [
    {
      "key": "<string>",
      "read_only": true,
      "value": "<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

region_id
integer
required

Region ID

load_balancer_id
string
required

Load balancer ID

Response

200 - application/json

Load Balancer status

id
string<uuid>
required

UUID of the entity

listeners
ListenerStatusSerializer · object[]
required

Listeners of the Load Balancer

name
string
required

Name of the load balancer

operating_status
enum<string>
required

Operating status of the entity

Available options:
DEGRADED,
DRAINING,
ERROR,
NO_MONITOR,
OFFLINE,
ONLINE
provisioning_status
enum<string>
required

Provisioning status of the entity

Available options:
ACTIVE,
DELETED,
ERROR,
PENDING_CREATE,
PENDING_DELETE,
PENDING_UPDATE
tags
TagSerializer · object[]

List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.