• Elastic Load Balancing

elb
  1. Help Center
  2. Elastic Load Balancing
  3. API Reference
  4. Enhanced Load Balancer APIs
  5. Load Balancer
  6. Modifying a Load Balancer

Modifying a Load Balancer

Function

This API is used to modify the name or description of a load balancer.

URI

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

Table 1 Parameter description

Parameter

Type

Mandatory

Description

loadbalancer_id

Uuid

Yes

Specifies the load balancer ID.

Request

Table 2 Parameter description

Parameter

Type

Mandatory

Description

loadbalancer

Dict

Yes

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

Table 3 loadbalancer field description

Parameter

Type

Mandatory

Description

name

String (255)

No

Specifies the load balancer name.

description

String (255)

No

Provides supplementary information about the load balancer.

admin_state_up

Bool

No

  • Specifies the administrative status of the load balancer.
  • This parameter is reserved and has been not used. The default value is true.

Response

Table 4 Parameter description

Parameter

Type

Description

loadbalancer

Dict

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

Table 5 loadbalancer field description

Parameter

Type

Description

id

Uuid

Specifies the load balancer ID.

tenant_id

String (255)

Specifies the ID of the project where the load balancer is used.

name

String (255)

Specifies the load balancer name.

description

String (255)

Provides supplementary information about the load balancer.

vip_subnet_id

Uuid

Specifies the ID of the subnet where the load balancer works.

vip_port_id

Uuid

Specifies the ID of the port bound to the load balancer IP address.

provider

String

Specifies the provider of the load balancer.

vip_address

String (64)

Specifies the IP address of the load balancer.

listeners

List

Lists the IDs of listeners added to the load balancer.

pools

List

Lists the IDs of backend server groups associated with the load balancer.

operating_status

String (16)

Specifies the operating status of the load balancer.

The value can be ONLINE, OFFLINE, DEGRADED, DISABLED, or NO_MONITOR.

This parameter is reserved and has been not used. The default value is ONLINE.

provisioning_status

String (16)

Specifies the provisioning status of the load balancer.

The value can be ACTIVE, PENDING_CREATE, or ERROR.

This parameter is reserved and has been not used. The default value is ACTIVE.

admin_state_up

Bool

Specifies the administrative status of the load balancer.

This parameter is reserved and has been not used. The default value is true.

tags

List

Lists load balancer tags.

created_at

String (19)

Specifies the time when the load balancer was created.

The time is in YYYY-MM-DDTHH:MM:SS format.

updated_at

String (19)

Specifies the time when the load balancer was updated.

The time is in YYYY-MM-DDTHH:MM:SS format.

Example

  • Example request: Updating the load balancer name and description
    PUT https://{Endpoint}/v2.0/lbaas/loadbalancers/1e11b74e-30b7-4b78-b09b-84aec4a04487
    
    {
        "loadbalancer": {
            "name": "lb_update_test", 
            "description": "lb update test"
        }
    }
  • Example response
    {
      "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",
        "tags": [],
        "provider": "vlb",
        "pools": [
          {
            "id": "75c4f2d4-a213-4408-9fa8-d64708e8d1df"
          }
        ],
        "id": "c32a9f9a-0cc6-4f38-bb9c-cde79a533c19",
        "operating_status": "ONLINE",
        "name": "loadbalancer-test2",
        "created_at": "2018-07-25T01:54:13", 
        "updated_at": "2018-07-25T01:54:14"
      }
    } 

Response Codes

For details, see HTTP Status Codes for Enhanced Load Balancers.