Documentation | Load Balancers › Check Quota For Load Balancer Creation

Load Balancers

load_balancers

Methods

Check Quota For Load Balancer Creation -> { baremetal_basic_count_limit, baremetal_basic_count_requested, baremetal_basic_count_usage, 126 more... }

post/v1/loadbalancers/{project_id}/{region_id}/check_limits

Check if regional quota is exceeded, if yes the number of additional quotas needed to create the specified load balancer will be calculated

Parameters

project_id: number

region_id: number

Response fields

baremetal_basic_count_limit: number

Optional

Basic bare metal servers count limit

baremetal_basic_count_requested: number

Optional

Basic bare metal servers count requested

baremetal_basic_count_usage: number

Optional

Basic bare metal servers count usage

baremetal_gpu_count_limit: number

Optional

AI GPU bare metal servers count limit

baremetal_gpu_count_requested: number

Optional

AI GPU bare metal servers count requested

baremetal_gpu_count_usage: number

Optional

AI GPU bare metal servers count usage

baremetal_hf_count_limit: number

Optional

High-frequency bare metal servers count limit

baremetal_hf_count_requested: number

Optional

High-frequency bare metal servers count requested

baremetal_hf_count_usage: number

Optional

High-frequency bare metal servers count usage

baremetal_infrastructure_count_limit: number

Optional

Infrastructure bare metal servers count limit

baremetal_infrastructure_count_requested: number

Optional

Infrastructure bare metal servers count requested

baremetal_infrastructure_count_usage: number

Optional

Infrastructure bare metal servers count usage

baremetal_network_count_limit: number

Optional

Bare metal Network Count limit

baremetal_network_count_requested: number

Optional

Bare metal Network Count requested

baremetal_network_count_usage: number

Optional

Bare metal Network Count usage

baremetal_storage_count_limit: number

Optional

Storage bare metal servers count limit

baremetal_storage_count_requested: number

Optional

Storage bare metal servers count requested

baremetal_storage_count_usage: number

Optional

Storage bare metal servers count usage

caas_container_count_limit: number

Optional

Containers count limit

caas_container_count_requested: number

Optional

Containers count requested

caas_container_count_usage: number

Optional

Containers count usage

caas_cpu_count_limit: number

Optional

mCPU count for containers limit

caas_cpu_count_requested: number

Optional

mCPU count for containers requested

caas_cpu_count_usage: number

Optional

mCPU count for containers usage

caas_gpu_count_limit: number

Optional

Containers gpu count limit

caas_gpu_count_requested: number

Optional

Containers gpu count requested

caas_gpu_count_usage: number

Optional

Containers gpu count usage

caas_ram_size_limit: number

Optional

MB memory count for containers limit

caas_ram_size_requested: number

Optional

MB memory count for containers requested

caas_ram_size_usage: number

Optional

MB memory count for containers usage

cluster_count_limit: number

Optional

K8s clusters count limit

cluster_count_requested: number

Optional

K8s clusters count requested

cluster_count_usage: number

Optional

K8s clusters count usage

cpu_count_limit: number

Optional

vCPU Count limit

cpu_count_requested: number

Optional

vCPU Count requested

cpu_count_usage: number

Optional

vCPU Count usage

dbaas_postgres_cluster_count_limit: number

Optional

DBaaS cluster count limit

dbaas_postgres_cluster_count_requested: number

Optional

DBaaS cluster count requested

dbaas_postgres_cluster_count_usage: number

Optional

DBaaS cluster count usage

external_ip_count_limit: number

Optional

External IP Count limit

external_ip_count_requested: number

Optional

External IP Count requested

external_ip_count_usage: number

Optional

External IP Count usage

faas_cpu_count_limit: number

Optional

mCPU count for functions limit

faas_cpu_count_requested: number

Optional

mCPU count for functions requested

faas_cpu_count_usage: number

Optional

mCPU count for functions usage

faas_function_count_limit: number

Optional

Functions count limit

faas_function_count_requested: number

Optional

Functions count requested

faas_function_count_usage: number

Optional

Functions count usage

faas_namespace_count_limit: number

Optional

Functions namespace count limit

faas_namespace_count_requested: number

Optional

Functions namespace count requested

faas_namespace_count_usage: number

Optional

Functions namespace count usage

faas_ram_size_limit: number

Optional

MB memory count for functions limit

faas_ram_size_requested: number

Optional

MB memory count for functions requested

faas_ram_size_usage: number

Optional

MB memory count for functions usage

firewall_count_limit: number

Optional

Firewalls Count limit

firewall_count_requested: number

Optional

Firewalls Count requested

firewall_count_usage: number

Optional

Firewalls Count usage

floating_count_limit: number

Optional

Floating IP Count limit

floating_count_requested: number

Optional

Floating IP Count requested

floating_count_usage: number

Optional

Floating IP Count usage

gpu_count_limit: number

Optional

GPU Count limit

gpu_count_requested: number

Optional

GPU Count requested

gpu_count_usage: number

Optional

GPU Count usage

image_count_limit: number

Optional

Images Count limit

image_count_requested: number

Optional

Images Count requested

image_count_usage: number

Optional

Images Count usage

image_size_limit: number

Optional

Images Size, GiB limit

image_size_requested: number

Optional

Images Size, GiB requested

image_size_usage: number

Optional

Images Size, GiB usage

ipu_count_limit: number

Optional

IPU Count limit

ipu_count_requested: number

Optional

IPU Count requested

ipu_count_usage: number

Optional

IPU Count usage

laas_topic_count_limit: number

Optional

LaaS Topics Count limit

laas_topic_count_requested: number

Optional

LaaS Topics Count requested

laas_topic_count_usage: number

Optional

LaaS Topics Count usage

loadbalancer_count_limit: number

Optional

Load Balancers Count limit

loadbalancer_count_requested: number

Optional

Load Balancers Count requested

loadbalancer_count_usage: number

Optional

Load Balancers Count usage

network_count_limit: number

Optional

Networks Count limit

network_count_requested: number

Optional

Networks Count requested

network_count_usage: number

Optional

Networks Count usage

ram_limit: number

Optional

RAM Size, GiB limit

ram_requested: number

Optional

RAM Size, GiB requested

ram_usage: number

Optional

RAM Size, GiB usage

registry_count_limit: number

Optional

Registries count limit

registry_count_requested: number

Optional

Registries count requested

registry_count_usage: number

Optional

Registries count usage

registry_storage_limit: number

Optional

Registries volume usage, GiB limit

registry_storage_requested: number

Optional

Registries volume usage, GiB requested

registry_storage_usage: number

Optional

Registries volume usage, GiB usage

router_count_limit: number

Optional

Routers Count limit

router_count_requested: number

Optional

Routers Count requested

router_count_usage: number

Optional

Routers Count usage

secret_count_limit: number

Optional

Secret Count limit

secret_count_requested: number

Optional

Secret Count requested

secret_count_usage: number

Optional

Secret Count usage

servergroup_count_limit: number

Optional

Placement Group Count limit

servergroup_count_requested: number

Optional

Placement Group Count requested

servergroup_count_usage: number

Optional

Placement Group Count usage

sfs_count_limit: number

Optional

Shared file system Count limit

sfs_count_requested: number

Optional

Shared file system Count requested

sfs_count_usage: number

Optional

Shared file system Count usage

sfs_size_limit: number

Optional

Shared file system Size, GiB limit

sfs_size_requested: number

Optional

Shared file system Size, GiB requested

sfs_size_usage: number

Optional

Shared file system Size, GiB usage

shared_vm_count_limit: number

Optional

Basic VMs Count limit

shared_vm_count_requested: number

Optional

Basic VMs Count requested

shared_vm_count_usage: number

Optional

Basic VMs Count usage

snapshot_schedule_count_limit: number

Optional

Snapshot Schedules Count limit

snapshot_schedule_count_requested: number

Optional

Snapshot Schedules Count requested

snapshot_schedule_count_usage: number

Optional

Snapshot Schedules Count usage

subnet_count_limit: number

Optional

Subnets Count limit

subnet_count_requested: number

Optional

Subnets Count requested

subnet_count_usage: number

Optional

Subnets Count usage

vm_count_limit: number

Optional

Instances Dedicated Count limit

vm_count_requested: number

Optional

Instances Dedicated Count requested

vm_count_usage: number

Optional

Instances Dedicated Count usage

volume_count_limit: number

Optional

Volumes Count limit

volume_count_requested: number

Optional

Volumes Count requested

volume_count_usage: number

Optional

Volumes Count usage

volume_size_limit: number

Optional

Volumes Size, GiB limit

volume_size_requested: number

Optional

Volumes Size, GiB requested

volume_size_usage: number

Optional

Volumes Size, GiB usage

volume_snapshots_count_limit: number

Optional

Snapshots Count limit

volume_snapshots_count_requested: number

Optional

Snapshots Count requested

volume_snapshots_count_usage: number

Optional

Snapshots Count usage

volume_snapshots_size_limit: number

Optional

Snapshots Size, GiB limit

volume_snapshots_size_requested: number

Optional

Snapshots Size, GiB requested

volume_snapshots_size_usage: number

Optional

Snapshots Size, GiB usage

Request example

curl https://api.gcore.com/cloud/v1/loadbalancers/$PROJECT_ID/$REGION_ID/check_limits \
    -H 'Content-Type: application/json' \
    -H "APIKey: $CLOUD_API_API_KEY"

200Example

{
  "baremetal_basic_count_limit": 0,
  "baremetal_basic_count_requested": 1,
  "baremetal_basic_count_usage": 0,
  "baremetal_gpu_count_limit": 0,
  "baremetal_gpu_count_requested": 1,
  "baremetal_gpu_count_usage": 0,
  "baremetal_hf_count_limit": 0,
  "baremetal_hf_count_requested": 1,
  "baremetal_hf_count_usage": 0,
  "baremetal_infrastructure_count_limit": 0,
  "baremetal_infrastructure_count_requested": 1,
  "baremetal_infrastructure_count_usage": 0,
  "baremetal_network_count_limit": 0,
  "baremetal_network_count_requested": 1,
  "baremetal_network_count_usage": 0,
  "baremetal_storage_count_limit": 0,
  "baremetal_storage_count_requested": 1,
  "baremetal_storage_count_usage": 0,
  "caas_container_count_limit": 0,
  "caas_container_count_requested": 1,
  "caas_container_count_usage": 0,
  "caas_cpu_count_limit": 0,
  "caas_cpu_count_requested": 1,
  "caas_cpu_count_usage": 0,
  "caas_gpu_count_limit": 0,
  "caas_gpu_count_requested": 1,
  "caas_gpu_count_usage": 0,
  "caas_ram_size_limit": 0,
  "caas_ram_size_requested": 1,
  "caas_ram_size_usage": 0,
  "cluster_count_limit": 0,
  "cluster_count_requested": 1,
  "cluster_count_usage": 0,
  "cpu_count_limit": 0,
  "cpu_count_requested": 1,
  "cpu_count_usage": 0,
  "dbaas_postgres_cluster_count_limit": 0,
  "dbaas_postgres_cluster_count_requested": 1,
  "dbaas_postgres_cluster_count_usage": 0,
  "external_ip_count_limit": 0,
  "external_ip_count_requested": 1,
  "external_ip_count_usage": 0,
  "faas_cpu_count_limit": 0,
  "faas_cpu_count_requested": 1,
  "faas_cpu_count_usage": 0,
  "faas_function_count_limit": 0,
  "faas_function_count_requested": 1,
  "faas_function_count_usage": 0,
  "faas_namespace_count_limit": 0,
  "faas_namespace_count_requested": 1,
  "faas_namespace_count_usage": 0,
  "faas_ram_size_limit": 0,
  "faas_ram_size_requested": 1,
  "faas_ram_size_usage": 0,
  "firewall_count_limit": 0,
  "firewall_count_requested": 1,
  "firewall_count_usage": 0,
  "floating_count_limit": 0,
  "floating_count_requested": 1,
  "floating_count_usage": 0,
  "gpu_count_limit": 0,
  "gpu_count_requested": 1,
  "gpu_count_usage": 0,
  "image_count_limit": 0,
  "image_count_requested": 1,
  "image_count_usage": 0,
  "image_size_limit": 0,
  "image_size_requested": 1,
  "image_size_usage": 0,
  "ipu_count_limit": 0,
  "ipu_count_requested": 1,
  "ipu_count_usage": 0,
  "laas_topic_count_limit": 0,
  "laas_topic_count_requested": 1,
  "laas_topic_count_usage": 0,
  "loadbalancer_count_limit": 0,
  "loadbalancer_count_requested": 1,
  "loadbalancer_count_usage": 0,
  "network_count_limit": 0,
  "network_count_requested": 1,
  "network_count_usage": 0,
  "ram_limit": 0,
  "ram_requested": 1,
  "ram_usage": 0,
  "registry_count_limit": 0,
  "registry_count_requested": 1,
  "registry_count_usage": 0,
  "registry_storage_limit": 0,
  "registry_storage_requested": 1,
  "registry_storage_usage": 0,
  "router_count_limit": 0,
  "router_count_requested": 1,
  "router_count_usage": 0,
  "secret_count_limit": 0,
  "secret_count_requested": 1,
  "secret_count_usage": 0,
  "servergroup_count_limit": 0,
  "servergroup_count_requested": 1,
  "servergroup_count_usage": 0,
  "sfs_count_limit": 0,
  "sfs_count_requested": 1,
  "sfs_count_usage": 0,
  "sfs_size_limit": 0,
  "sfs_size_requested": 1,
  "sfs_size_usage": 0,
  "shared_vm_count_limit": 0,
  "shared_vm_count_requested": 1,
  "shared_vm_count_usage": 0,
  "snapshot_schedule_count_limit": 0,
  "snapshot_schedule_count_requested": 1,
  "snapshot_schedule_count_usage": 0,
  "subnet_count_limit": 0,
  "subnet_count_requested": 1,
  "subnet_count_usage": 0,
  "vm_count_limit": 0,
  "vm_count_requested": 1,
  "vm_count_usage": 0,
  "volume_count_limit": 0,
  "volume_count_requested": 1,
  "volume_count_usage": 0,
  "volume_size_limit": 0,
  "volume_size_requested": 1,
  "volume_size_usage": 0,
  "volume_snapshots_count_limit": 0,
  "volume_snapshots_count_requested": 1,
  "volume_snapshots_count_usage": 0,
  "volume_snapshots_size_limit": 0,
  "volume_snapshots_size_requested": 1,
  "volume_snapshots_size_usage": 0
}

Create Load Balancer -> { tasks }

post/v1/loadbalancers/{project_id}/{region_id}

Create load balancer

Delete Load Balancer -> { tasks }

delete/v1/loadbalancers/{project_id}/{region_id}/{loadbalancer_id}

Delete load balancer

Failover Loadbalancer -> { tasks }

post/v1/loadbalancers/{project_id}/{region_id}/{loadbalancer_id}/failover

Failover loadbalancer

List Load Balancers -> OffsetPage<

Loadbalancer

get/v1/loadbalancers/{project_id}/{region_id}

List load balancers

List Load Balancer Flavors -> { count, results }

get/v1/lbflavors/{project_id}/{region_id}

Retrieve a list of load balancer flavors. When the include_prices query parameter is specified, the list shows prices. A client in trial mode gets all price values as 0. If you get Pricing Error contact the support

Resize Loadbalancer -> { tasks }

post/v1/loadbalancers/{project_id}/{region_id}/{loadbalancer_id}/resize

Resize loadbalancer

Get Load Balancer ->

Loadbalancer

get/v1/loadbalancers/{project_id}/{region_id}/{loadbalancer_id}

Get load balancer

Rename Load Balancer Activate Deactivate Logs Or Update Preferred Connectivity For Load Balancer ->

Loadbalancer

patch/v1/loadbalancers/{project_id}/{region_id}/{loadbalancer_id}

Rename load balancer, activate/deactivate logs or update preferred connectivity for load balancer

Domain types

Loadbalancer = { id, created_at, name, 21 more... }

Load Balancers

Listeners

load_balancers.listeners

Methods

Create Load Balancer Listener -> { tasks }

post/v1/lblisteners/{project_id}/{region_id}

Create load balancer listener

Delete Load Balancer Listener -> { tasks }

delete/v1/lblisteners/{project_id}/{region_id}/{listener_id}

Delete load balancer listener

List Load Balancer Listeners -> { count, results }

get/v1/lblisteners/{project_id}/{region_id}

List load balancer listeners

Get Listener -> { id, connection_limit, insert_headers, 17 more... }

get/v1/lblisteners/{project_id}/{region_id}/{listener_id}

Get listener

Update Listener -> { tasks }

patch/v2/lblisteners/{project_id}/{region_id}/{listener_id}

Update listener

Edit Listener Name -> { id, connection_limit, insert_headers, 16 more... }

patch/v1/lblisteners/{project_id}/{region_id}/{listener_id}

Edit listener name

Load Balancers

Metadata

load_balancers.metadata

Methods

Deprecated Create Or Update Loadbalancer Metadata ->

post/v1/loadbalancers/{project_id}/{region_id}/{loadbalancer_id}/metadata

Create or update one or more metadata items for a loadbalancer. If an item does not exist, it gets created. If an item already exists, it's value is overwritten

Create Or Update Loadbalancer Metadata V2 -> { tasks }

post/v2/loadbalancers/{project_id}/{region_id}/{loadbalancer_id}/metadata

Create or update one or more metadata items for a loadbalancer. If an item does not exist, it gets created. If an item already exists, it's value is overwritten

List Loadbalancer Metadata -> { count, results }

get/v1/loadbalancers/{project_id}/{region_id}/{loadbalancer_id}/metadata

Lists all metadata for a loadbalancer

Deprecated Replace Loadbalancer Metadata ->

put/v1/loadbalancers/{project_id}/{region_id}/{loadbalancer_id}/metadata

All existing metadata is deleted and replaced with the metadata from the request.

Replace Loadbalancer Metadata V2 -> { tasks }

put/v2/loadbalancers/{project_id}/{region_id}/{loadbalancer_id}/metadata

All existing metadata is deleted and replaced with the metadata from the request.

Load Balancers

Metadata Item

load_balancers.metadata_item

Methods

Deprecated Delete Loadbalancer Metadata Item By Key ->

delete/v1/loadbalancers/{project_id}/{region_id}/{loadbalancer_id}/metadata_item

Delete loadbalancer metadata item by key

Delete Loadbalancer Metadata Item By Key V2 -> { tasks }

delete/v2/loadbalancers/{project_id}/{region_id}/{loadbalancer_id}/metadata_item

Delete loadbalancer metadata item by key

Get Loadbalancer Metadata Item By Key -> { key, read_only, value }

get/v1/loadbalancers/{project_id}/{region_id}/{loadbalancer_id}/metadata_item

Get loadbalancer metadata item by key

Load Balancers

Metrics

load_balancers.metrics

Methods

Get Loadbalancer Metrics -> { count, results }

post/v1/loadbalancers/{project_id}/{region_id}/{loadbalancer_id}/metrics

Get loadbalancer metrics, including cpu, memory and network

Load Balancers

Policies

load_balancers.policies

Methods

Create Load Balancer L7 Policy -> { tasks }

post/v1/l7policies/{project_id}/{region_id}

Create load balancer L7 policy

Delete Load Balancer L7 Policy -> { tasks }

delete/v1/l7policies/{project_id}/{region_id}/{l7policy_id}

Delete load balancer L7 policy

List Load Balancer L7 Policies -> { count, results }

get/v1/l7policies/{project_id}/{region_id}

List load balancer L7 policies

Get Load Balancer L7 Policy -> { id, action, listener_id, 14 more... }

get/v1/l7policies/{project_id}/{region_id}/{l7policy_id}

Get load balancer L7 policy

Replace Load Balancer L7 Policy Properties -> { tasks }

put/v1/l7policies/{project_id}/{region_id}/{l7policy_id}

Replace load balancer L7 policy properties

Load Balancers Policies

Rules

load_balancers.policies.rules

Methods

Create Load Balancer L7 Rule -> { tasks }

post/v1/l7policies/{project_id}/{region_id}/{l7policy_id}/rules

Create load balancer L7 rule

Delete Load Balancer L7 Rule -> { tasks }

delete/v1/l7policies/{project_id}/{region_id}/{l7policy_id}/rules/{l7rule_id}

Delete load balancer L7 rule

List Load Balancer L7 Policy Rules -> { count, results }

get/v1/l7policies/{project_id}/{region_id}/{l7policy_id}/rules

List load balancer L7 policy rules

Get Load Balancer L7 Rule -> { id, compare_type, invert, 10 more... }

get/v1/l7policies/{project_id}/{region_id}/{l7policy_id}/rules/{l7rule_id}

Get load balancer L7 rule

Replace Load Balancer L7 Rule Properties -> { tasks }

put/v1/l7policies/{project_id}/{region_id}/{l7policy_id}/rules/{l7rule_id}

Replace load balancer L7 rule properties

Load Balancers

Pools

load_balancers.pools

Methods

Create Load Balancer Pool -> { tasks }

post/v1/lbpools/{project_id}/{region_id}

Create load balancer pool

Delete Load Balancer Pool -> { tasks }

delete/v1/lbpools/{project_id}/{region_id}/{pool_id}

Delete load balancer pool

List Load Balancer Pools -> { count, results }

get/v1/lbpools/{project_id}/{region_id}

List load balancer pools

Get Load Balancer Pool -> { id, ca_secret_id, crl_secret_id, 16 more... }

get/v1/lbpools/{project_id}/{region_id}/{pool_id}

Get load balancer pool

Patch Load Balancer Pool -> { tasks }

patch/v1/lbpools/{project_id}/{region_id}/{pool_id}

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.

Load Balancers Pools

Healthmonitor

load_balancers.pools.healthmonitor

Methods

Create Load Balancer Pool Health Monitor -> { tasks }

post/v1/lbpools/{project_id}/{region_id}/{pool_id}/healthmonitor

Create Load Balancer Pool Health Monitor

Delete Load Balancer Pool Health Monitor ->

delete/v1/lbpools/{project_id}/{region_id}/{pool_id}/healthmonitor

Delete load balancer pool health monitor

Load Balancers Pools

Member

load_balancers.pools.member

Methods

Create Load Balancer Pool Member -> { tasks }

post/v1/lbpools/{project_id}/{region_id}/{pool_id}/member

Create load balancer pool member

Delete Load Balancer Pool Member -> { tasks }

delete/v1/lbpools/{project_id}/{region_id}/{pool_id}/member/{member_id}

Delete load balancer pool member

Load Balancers

Securitygroup

load_balancers.securitygroup

Methods

Deprecated Create A Custom Security Group For The Load Balancer S Ingress Port ->

post/v1/loadbalancers/{project_id}/{region_id}/{loadbalancer_id}/securitygroup

Group will be populated with the default load balancer rules (AH, VRRP and TCP(ports 1025-1026) protocols). Also, current listener protocol ports will be allowed.

Deprecated Get The Custom Security Group For The Load Balancer S Ingress Port -> { count, results }

get/v1/loadbalancers/{project_id}/{region_id}/{loadbalancer_id}/securitygroup

Deprecated. Get the custom security group for the load balancer's ingress port

Load Balancers

Status

load_balancers.status

Methods

List Load Balancers Statuses -> { count, results }

get/v1/loadbalancers/{project_id}/{region_id}/status

List load balancers statuses

Get Load Balancer Status -> { id, listeners, name, 3 more... }

get/v1/loadbalancers/{project_id}/{region_id}/{loadbalancer_id}/status

Get load balancer status