Get load balancer

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 = client.cloud.load_balancers.get(
    load_balancer_id="load_balancer_id",
    project_id=0,
    region_id=0,
)
print(load_balancer.id)

{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "name": "<string>",
  "operating_status": "DEGRADED",
  "project_id": 123,
  "provisioning_status": "ACTIVE",
  "region": "<string>",
  "region_id": 123,
  "tags_v2": [
    {
      "key": "<string>",
      "read_only": true,
      "value": "<string>"
    }
  ],
  "additional_vips": [
    {
      "ip_address": "<string>",
      "subnet_id": "<string>"
    }
  ],
  "creator_task_id": "9f3ec11e-bcd4-4fe6-924a-a4439a56ad22",
  "ddos_profile": {
    "fields": [
      {
        "base_field": 10,
        "default": null,
        "description": "ARK server ports. Valid port values are in range 1000-65535",
        "field_name": "ARK Ports",
        "field_type": null,
        "field_value": "<unknown>",
        "id": 123,
        "name": "<string>",
        "required": true,
        "validation_schema": "<unknown>",
        "value": null
      }
    ],
    "id": 123,
    "options": {
      "active": true,
      "bgp": true
    },
    "profile_template": {
      "description": "description",
      "fields": [
        {
          "default": null,
          "description": "ARK server ports. Valid port values are in range 1000-65535",
          "field_type": null,
          "id": 123,
          "name": "<string>",
          "required": true,
          "validation_schema": "<unknown>"
        }
      ],
      "id": 123,
      "name": "<string>"
    },
    "profile_template_description": "ARK server ports. Valid port values are in range 1000-65535",
    "protocols": [
      {
        "port": "80",
        "protocols": [
          "TCP",
          "HTTP"
        ]
      },
      {
        "port": "53",
        "protocols": [
          "UDP"
        ]
      }
    ],
    "site": "ED",
    "status": {
      "error_description": "",
      "status": "Updated"
    }
  },
  "flavor": {
    "flavor_id": "1d276f53-2834-4855-9859-aa922f073055",
    "flavor_name": "lb1-1-2",
    "ram": 2048,
    "vcpus": 1
  },
  "floating_ips": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "creator_task_id": "d1e1500b-e2be-40aa-9a4b-cc493fa1af30",
      "fixed_ip_address": "192.168.10.15",
      "floating_ip_address": "172.24.4.34",
      "id": "<string>",
      "port_id": "ee2402d0-f0cd-4503-9b75-69be1d11c5f1",
      "project_id": 123,
      "region": "<string>",
      "region_id": 123,
      "router_id": "11005a33-c5ac-4c96-ab6f-8f2827cc7da6",
      "status": "ACTIVE",
      "tags": [
        {
          "key": "<string>",
          "read_only": true,
          "value": "<string>"
        }
      ],
      "task_id": "a4eb4b29-048e-42f6-a5e1-2c18bc001c45",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "listeners": [
    {
      "id": "<string>"
    }
  ],
  "logging": {
    "destination_region_id": 1,
    "enabled": true,
    "retention_policy": {
      "period": 45
    },
    "topic_name": "my-log-name"
  },
  "preferred_connectivity": "L2",
  "stats": {
    "active_connections": 0,
    "bytes_in": 34942398609,
    "bytes_out": 304777113641,
    "request_errors": 4,
    "total_connections": 21095970
  },
  "task_id": "<string>",
  "updated_at": "2019-06-18T11:57:00+0000",
  "vip_address": "5.5.5.5",
  "vip_ip_family": "ipv4",
  "vip_port_id": "4177d1ef-f1c2-4e45-a531-3e05dfa6d848",
  "vrrp_ips": [
    {
      "ip_address": "<string>",
      "role": "BACKUP",
      "subnet_id": "<string>"
    }
  ]
}

GET

cloud

loadbalancers

{project_id}

{region_id}

{load_balancer_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 = client.cloud.load_balancers.get(
    load_balancer_id="load_balancer_id",
    project_id=0,
    region_id=0,
)
print(load_balancer.id)

{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "name": "<string>",
  "operating_status": "DEGRADED",
  "project_id": 123,
  "provisioning_status": "ACTIVE",
  "region": "<string>",
  "region_id": 123,
  "tags_v2": [
    {
      "key": "<string>",
      "read_only": true,
      "value": "<string>"
    }
  ],
  "additional_vips": [
    {
      "ip_address": "<string>",
      "subnet_id": "<string>"
    }
  ],
  "creator_task_id": "9f3ec11e-bcd4-4fe6-924a-a4439a56ad22",
  "ddos_profile": {
    "fields": [
      {
        "base_field": 10,
        "default": null,
        "description": "ARK server ports. Valid port values are in range 1000-65535",
        "field_name": "ARK Ports",
        "field_type": null,
        "field_value": "<unknown>",
        "id": 123,
        "name": "<string>",
        "required": true,
        "validation_schema": "<unknown>",
        "value": null
      }
    ],
    "id": 123,
    "options": {
      "active": true,
      "bgp": true
    },
    "profile_template": {
      "description": "description",
      "fields": [
        {
          "default": null,
          "description": "ARK server ports. Valid port values are in range 1000-65535",
          "field_type": null,
          "id": 123,
          "name": "<string>",
          "required": true,
          "validation_schema": "<unknown>"
        }
      ],
      "id": 123,
      "name": "<string>"
    },
    "profile_template_description": "ARK server ports. Valid port values are in range 1000-65535",
    "protocols": [
      {
        "port": "80",
        "protocols": [
          "TCP",
          "HTTP"
        ]
      },
      {
        "port": "53",
        "protocols": [
          "UDP"
        ]
      }
    ],
    "site": "ED",
    "status": {
      "error_description": "",
      "status": "Updated"
    }
  },
  "flavor": {
    "flavor_id": "1d276f53-2834-4855-9859-aa922f073055",
    "flavor_name": "lb1-1-2",
    "ram": 2048,
    "vcpus": 1
  },
  "floating_ips": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "creator_task_id": "d1e1500b-e2be-40aa-9a4b-cc493fa1af30",
      "fixed_ip_address": "192.168.10.15",
      "floating_ip_address": "172.24.4.34",
      "id": "<string>",
      "port_id": "ee2402d0-f0cd-4503-9b75-69be1d11c5f1",
      "project_id": 123,
      "region": "<string>",
      "region_id": 123,
      "router_id": "11005a33-c5ac-4c96-ab6f-8f2827cc7da6",
      "status": "ACTIVE",
      "tags": [
        {
          "key": "<string>",
          "read_only": true,
          "value": "<string>"
        }
      ],
      "task_id": "a4eb4b29-048e-42f6-a5e1-2c18bc001c45",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "listeners": [
    {
      "id": "<string>"
    }
  ],
  "logging": {
    "destination_region_id": 1,
    "enabled": true,
    "retention_policy": {
      "period": 45
    },
    "topic_name": "my-log-name"
  },
  "preferred_connectivity": "L2",
  "stats": {
    "active_connections": 0,
    "bytes_in": 34942398609,
    "bytes_out": 304777113641,
    "request_errors": 4,
    "total_connections": 21095970
  },
  "task_id": "<string>",
  "updated_at": "2019-06-18T11:57:00+0000",
  "vip_address": "5.5.5.5",
  "vip_ip_family": "ipv4",
  "vip_port_id": "4177d1ef-f1c2-4e45-a531-3e05dfa6d848",
  "vrrp_ips": [
    {
      "ip_address": "<string>",
      "role": "BACKUP",
      "subnet_id": "<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

Loadbalancer ID

Query Parameters

show_stats

boolean

Show statistics

with_ddos

boolean

Show DDoS profile

Response

Returned load balancer

created_at

string<date-time>

required

Datetime when the load balancer was created

string<uuid4>

required

Load balancer ID

name

string

required

Load balancer name

operating_status

enum<string>

required

Load balancer operating status

Available options:

DEGRADED,

DRAINING,

ERROR,

NO_MONITOR,

OFFLINE,

ONLINE

project_id

integer

required

Project ID

provisioning_status

enum<string>

required

Load balancer lifecycle status

Available options:

ACTIVE,

DELETED,

ERROR,

PENDING_CREATE,

PENDING_DELETE,

PENDING_UPDATE

region

string

required

Region name

region_id

integer

required

Region ID

tags_v2

TagSerializer · object[]

required

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.

Show child attributes

tags_v2.key

string

required

Tag key. The maximum size for a key is 255 characters.

tags_v2.read_only

boolean

required

If true, the tag is read-only and cannot be modified by the user

tags_v2.value

string

required

Tag value. The maximum size for a value is 255 characters.

additional_vips

NetworkPortFixedIp · object[]

List of additional IP addresses

Show child attributes

additional_vips.ip_address

string<ipvanyaddress>

required

IP address

additional_vips.subnet_id

string<uuid4>

required

Subnet UUID

creator_task_id

string<uuid4> | null

Task that created this entity

Example:

"9f3ec11e-bcd4-4fe6-924a-a4439a56ad22"

ddos_profile

GetClientProfileSerializer · object

Loadbalancer advanced DDoS protection profile.

Show child attributes

ddos_profile.fields

ClientProfileFieldSerializer · object[]

required

List of configured field values for the protection profile

Show child attributes

ddos_profile.fields.base_field

integer | null

required

ID of DDoS profile field

Example:

10

ddos_profile.fields.default

string | null

required

Predefined default value for the field if not specified

Maximum string length: 100

Example:

null

ddos_profile.fields.description

string | null

required

Detailed description explaining the field's purpose and usage guidelines

Maximum string length: 255

Example:

"ARK server ports. Valid port values are in range 1000-65535"

ddos_profile.fields.field_name

string | null

required

Name of DDoS profile field

Example:

"ARK Ports"

ddos_profile.fields.field_type

string | null

required

Data type classification of the field (e.g., string, integer, array)

Example:

null

ddos_profile.fields.field_value

any

required

Complex value. Only one of 'value' or 'field_value' must be specified.

ddos_profile.fields.id

integer

required

Unique identifier for the DDoS protection field

ddos_profile.fields.name

string

required

Human-readable name of the protection field

Maximum string length: 30

ddos_profile.fields.required

boolean | null

required

Indicates whether this field must be provided when creating a protection profile

Example:

true

ddos_profile.fields.validation_schema

any

required

JSON schema defining validation rules and constraints for the field value

ddos_profile.fields.value

string | null

required

Basic type value. Only one of 'value' or 'field_value' must be specified.

Example:

null

ddos_profile.id

integer

required

Unique identifier for the DDoS protection profile

ddos_profile.options

ProfileOptionsSerializer · object

required

Configuration options controlling profile activation and BGP routing

Show child attributes

ddos_profile.options.active

boolean

required

Controls whether the DDoS protection profile is enabled and actively protecting the resource

ddos_profile.options.bgp

boolean

required

Enables Border Gateway Protocol (BGP) routing for DDoS protection traffic

ddos_profile.profile_template

ClientProfileTemplateSerializer · object

required

Complete template configuration data used for this profile

Show child attributes

ddos_profile.profile_template.description

string | null

required

Detailed description explaining the template's purpose and use cases

Example:

"description"

ddos_profile.profile_template.fields

ClientProfileTemplateFieldSerializer · object[]

required

List of configurable fields that define the template's protection parameters

Show child attributes

ddos_profile.profile_template.fields.default

string | null

required

Predefined default value for the field if not specified

Maximum string length: 100

Example:

null

ddos_profile.profile_template.fields.description

string | null

required

Detailed description explaining the field's purpose and usage guidelines

Maximum string length: 255

Example:

"ARK server ports. Valid port values are in range 1000-65535"

ddos_profile.profile_template.fields.field_type

string | null

required

Data type classification of the field (e.g., string, integer, array)

Example:

null

ddos_profile.profile_template.fields.id

integer

required

Unique identifier for the DDoS protection field

ddos_profile.profile_template.fields.name

string

required

Human-readable name of the protection field

Maximum string length: 30

ddos_profile.profile_template.fields.required

boolean | null

required

Indicates whether this field must be provided when creating a protection profile

Example:

true

ddos_profile.profile_template.fields.validation_schema

any

required

JSON schema defining validation rules and constraints for the field value

ddos_profile.profile_template.id

integer

required

Unique identifier for the DDoS protection template

ddos_profile.profile_template.name

string

required

Human-readable name of the protection template

Maximum string length: 100

ddos_profile.profile_template_description

string | null

required

Detailed description of the protection template used for this profile

Example:

"ARK server ports. Valid port values are in range 1000-65535"

ddos_profile.protocols

ProtocolsOnPortSerializer · object[] | null

required

List of network protocols and ports configured for protection

Show child attributes

ddos_profile.protocols.port

string

required

Network port number for which protocols are configured

ddos_profile.protocols.protocols

string[]

required

List of network protocols enabled on the specified port

Example:

[
  {
    "port": "80",
    "protocols": ["TCP", "HTTP"]
  },
  { "port": "53", "protocols": ["UDP"] }
]

ddos_profile.site

string | null

required

Geographic site identifier where the protection is deployed

Maximum string length: 50

Example:

"ED"

ddos_profile.status

DdosProfileStatusSerializer · object

required

Current operational status and any error information for the profile

Show child attributes

ddos_profile.status.error_description

string

required

Detailed error message describing any issues with the profile operation

ddos_profile.status.status

string

required

Current operational status of the DDoS protection profile

Required string length: 3 - 30

Example:

{
  "error_description": "",
  "status": "Updated"
}

flavor

LbFlavorSerializer · object

Load balancer flavor (if not default)

Show child attributes

flavor.flavor_id

string

required

Flavor ID is the same as name

flavor.flavor_name

string

required

Flavor name

flavor.ram

integer

required

RAM size in MiB

flavor.vcpus

integer

required

Virtual CPU count. For bare metal flavors, it's a physical CPU count

Example:

{
  "flavor_id": "1d276f53-2834-4855-9859-aa922f073055",
  "flavor_name": "lb1-1-2",
  "ram": 2048,
  "vcpus": 1
}

floating_ips

FloatingIPSerializer · object[]

List of assigned floating IPs

Show child attributes

floating_ips.created_at

string<date-time>

required

Datetime when the floating IP was created

floating_ips.creator_task_id

string<uuid4> | null

required

Task that created this entity

Example:

"d1e1500b-e2be-40aa-9a4b-cc493fa1af30"

floating_ips.fixed_ip_address

string<ipvanyaddress> | null

required

IP address of the port the floating IP is attached to

Example:

"192.168.10.15"

floating_ips.floating_ip_address

string<ipvanyaddress> | null

required

IP Address of the floating IP

Example:

"172.24.4.34"

floating_ips.id

string<uuid4>

required

Floating IP ID

floating_ips.port_id

string<uuid4> | null

required

Port ID the floating IP is attached to. The fixed_ip_address is the IP address of the port.

Example:

"ee2402d0-f0cd-4503-9b75-69be1d11c5f1"

floating_ips.project_id

integer

required

Project ID

floating_ips.region

string

required

Region name

floating_ips.region_id

integer

required

Region ID

floating_ips.router_id

string<uuid4> | null

required

Router ID

Example:

"11005a33-c5ac-4c96-ab6f-8f2827cc7da6"

floating_ips.status

enum<string> | null

required

Floating IP status. DOWN - unassigned (available). ACTIVE - attached to a port (in use). ERROR - error state.

Available options:

ACTIVE,

DOWN,

ERROR

Example:

"ACTIVE"

floating_ips.tags

TagSerializer · object[]

required

Show child attributes

floating_ips.tags.key

string

required

Tag key. The maximum size for a key is 255 characters.

floating_ips.tags.read_only

boolean

required

If true, the tag is read-only and cannot be modified by the user

floating_ips.tags.value

string

required

Tag value. The maximum size for a value is 255 characters.

floating_ips.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:

"a4eb4b29-048e-42f6-a5e1-2c18bc001c45"

floating_ips.updated_at

string<date-time>

required

Datetime when the floating IP was last updated

listeners

ListenerSerializer · object[]

Load balancer listeners

Show child attributes

listeners.id

string<uuid4>

required

Listener ID

logging

LoggingOutSerializer · object

Logging configuration

Show child attributes

logging.destination_region_id

integer | null

required

ID of the region in which the logs will be stored

Example:

1

logging.enabled

boolean

required

Indicates if log streaming is enabled or disabled

logging.topic_name

string | null

required

The topic name to stream logs to

Example:

"my-log-name"

logging.retention_policy

LaasIndexRetentionPolicyPydanticSerializer · object

Logs retention policy

Show child attributes

logging.retention_policy.period

integer | null

required

Duration of days for which logs must be kept.

Required range: 0 < x <= 1825

Example:

45

Example:

{ "period": 45 }

Example:

{
  "destination_region_id": 1,
  "enabled": true,
  "retention_policy": { "period": 45 },
  "topic_name": "my-log-name"
}

preferred_connectivity

enum<string>

default:L2

Preferred option to establish connectivity between load balancer and its pools members

Available options:

L2,

L3

stats

LoadbalancerStatsSerializer · object

Statistics of load balancer.

Show child attributes

stats.active_connections

integer

required

Currently active connections

stats.bytes_in

integer

required

Total bytes received

stats.bytes_out

integer

required

Total bytes sent

stats.request_errors

integer

required

Total requests that were unable to be fulfilled

stats.total_connections

integer

required

Total connections handled

Example:

{
  "active_connections": 0,
  "bytes_in": 34942398609,
  "bytes_out": 304777113641,
  "request_errors": 4,
  "total_connections": 21095970
}

task_id

string<uuid4> | null

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.

updated_at

string<date-time> | null

Datetime when the load balancer was last updated

Example:

"2019-06-18T11:57:00+0000"

vip_address

string<ipvanyaddress> | null

Load balancer IP address

Example:

"5.5.5.5"

vip_ip_family

enum<string> | null

Load balancer IP family

Available options:

dual,

ipv4,

ipv6

Example:

"ipv4"

vip_port_id

string<uuid4> | null

The ID of the Virtual IP (VIP) port.

Example:

"4177d1ef-f1c2-4e45-a531-3e05dfa6d848"

vrrp_ips

VRRPIP · object[]

List of VRRP IP addresses

Show child attributes

vrrp_ips.ip_address

string<ipvanyaddress>

required

IP address

vrrp_ips.role

enum<string>

required

LoadBalancer instance role to which VRRP IP belong

Available options:

BACKUP,

MASTER,

STANDALONE

vrrp_ips.subnet_id

string<uuid4>

required

Subnet UUID

Create load balancer Delete load balancer

⌘I

Overview

IAM

CDN

Managed DNS

Cloud

DDoS Protection

FastEdge

WAAP

Streaming

Object Storage

Resellers

Authorizations

Path Parameters

Query Parameters

Response