Documentation | Load Balancers › Pools › Patch Load Balancer Pool

API Reference

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

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.

Parameters

project_id: number

region_id: number

pool_id: string

Response fields

tasks: Array<string>

Optional

Task list

Request example

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

200Example

{
  "tasks": [
    "d478ae29-dedc-4869-82f0-96104425f565"
  ]
}

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