Change Load Balancer

PUT 
https://core-pl.ocplanet.cloud/backend/api/openstack/lbaas-load-balancers/:load-balancer_id

Host: https://core.ocplanet.cloud

Change specific load balancer identified by its unique ID.

Request

application/json

Body

admin_state_up booleanrequired
description stringrequired
id stringrequired
name stringrequired
connection_limit integers
default_pool_id string
timeout_client_data integers
timeout_member_conn integers
timeout_member_data integers
timeout_tcp_inspect integers

Responses

200

application/json

Schema

Schema

admin_state_up booleanrequired
availability_zone nullrequired
created_at stringrequired
description stringrequired
flavor_id nullrequired
floating_ip nullrequired
id stringrequired
listeners object[]required
Array [
id stringrequired
]
name stringrequired
operating_status stringrequired
pools object[]required
Array [
id stringrequired
]
project_id stringrequired
provider stringrequired
provisioning_status stringrequired
tags arrayrequired
updated_at stringrequired
vip_address stringrequired
vip_network_id stringrequired
vip_port_id stringrequired
vip_qos_policy_id nullrequired
vip_subnet_id stringrequired

Example (from schema)

{
  "admin_state_up": true,
  "created_at": "string",
  "description": "string",
  "id": "string",
  "listeners": [
    {
      "id": "string"
    }
  ],
  "name": "string",
  "operating_status": "string",
  "pools": [
    {
      "id": "string"
    }
  ],
  "project_id": "string",
  "provider": "string",
  "provisioning_status": "string",
  "tags": [
    null
  ],
  "updated_at": "string",
  "vip_address": "string",
  "vip_network_id": "string",
  "vip_port_id": "string",
  "vip_subnet_id": "string"
}

Example

{
  "id": "80d5d0a5-78cf-47ae-93b1-b6861773df3d",
  "description": "",
  "admin_state_up": true,
  "project_id": "50caa053ebc847c39b9c3149c746f0fa",
  "provisioning_status": "PENDING_UPDATE",
  "flavor_id": null,
  "vip_subnet_id": "04830e34-ee2b-4257-8c25-fddcd3c3eeba",
  "listeners": [
    {
      "id": "ca966622-ad49-4dba-ad0b-14536ab547a5"
    }
  ],
  "vip_address": "10.0.1.223",
  "vip_network_id": "d76c58ea-98ca-4abe-a9b9-0a04f1740a71",
  "vip_port_id": "41ed6e5e-5ebf-4b1a-9cfc-7bc615901ff5",
  "provider": "amphora",
  "pools": [
    {
      "id": "63035588-e319-43d4-9a0c-ccb2b8afbd0c"
    },
    {
      "id": "780bc547-e964-4da2-941b-70c821830704"
    },
    {
      "id": "948971dd-708c-4774-9e9c-705bc2c3feff"
    },
    {
      "id": "d1008e5f-4c0f-4d63-ba0b-b8f91da5fbf3"
    },
    {
      "id": "e95eaf85-6781-4813-85be-96261775e2dd"
    },
    {
      "id": "fe6cb8d3-9cf0-4557-bb8c-951a619f6a3c"
    }
  ],
  "created_at": "2024-03-21T10:10:19",
  "updated_at": "2024-03-21T12:20:16",
  "operating_status": "ERROR",
  "name": "LB",
  "vip_qos_policy_id": null,
  "availability_zone": null,
  "tags": [],
  "floating_ip": null
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Use 'OpenAPIToken {token}' as the value

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X PUT 'https://core-pl.ocplanet.cloud/backend/api/openstack/lbaas-load-balancers/:load-balancer_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
  "admin_state_up": true,
  "description": "string",
  "id": "string",
  "name": "string",
  "default_pool_id": "string"
}'

Request Collapse all

Base URL

https://core-pl.ocplanet.cloud

Auth

apikey header authorization

Body

• Example (from schema)
• Example

{
  "admin_state_up": true,
  "description": "string",
  "id": "string",
  "name": "string",
  "default_pool_id": "string"
}

ResponseClear

Click the Send API Request button above and see the response here!