• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Neutron
  5. LBaas
  6. Update load balancer

Update load balancer

Function Description

This interface is used to update a load balancer.

Interface Format

Method

URI

Description

PUT

/v2.0/lbaas/loadbalancers/{loadbalancer_id}

Updates information about a load balancer.

Restrictions

Only the name and description of a load balancer can be updated.

Request Parameter

Parameter

Type

Mandatory

Description

loadbalancer

Dict

Yes

Specifies the load balancer. For details, see Table 1.

Response Parameter

Parameter

Type

Mandatory

Description

loadbalancer

Dict

Yes

Specifies the load balancer. For details, see Table 1.

Request Example

PUT  /v2.0/lbaas/loadbalancers/a36c20d0-18e9-42ce-88fd-82a35977ee8c
{
    "loadbalancer": {
        "description": "simple lb2",
        "name": "loadbalancer-test2"
    }
}

Response Example

{
  "loadbalancer": {
    "description": "simple lb2",
    "admin_state_up": true,
    "tenant_id": "145483a5107745e9b3d80f956713e6a3",
    "provisioning_status": "ACTIVE",
    "vip_subnet_id": "823d5866-6e30-45c2-9b1a-a1ebc3757fdb",
    "listeners": [
      {
        "id": "37ffe679-08ef-436e-b6bd-cf66fb4c3de2"
      }
    ],
    "vip_address": "192.172.1.68",
    "vip_port_id": "f42e3019-67f7-4d2a-8d1c-af49e7c22fa6",
    "provider": "vlb",
    "pools": [
      {
        "id": "75c4f2d4-a213-4408-9fa8-d64708e8d1df"
      }
    ],
    "id": "c32a9f9a-0cc6-4f38-bb9c-cde79a533c19",
    "operating_status": "ONLINE",
    "name": "loadbalancer-test2"
  }
} 

Error Code

See section Return Code Processing.