Modifying a Load Balancer

Function

This API is used to modify the name, description, bandwidth, and administrative status of a load balancer.

URI

PUT /v1.0/{project_id}/elbaas/loadbalancers/{loadbalancer_id}

Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

loadbalancer_id

Yes

String

Specifies the load balancer ID.

name

No

String

  • Specifies the load balancer name.
  • The value can contain 1 to 64 characters that consist of letters, digits, underscores (_), and hyphens (-).

description

No

String

  • Provides supplementary information about the load balancer.
  • The value contains 0 to 128 characters and cannot contain angle brackets (< and >).

bandwidth

No

Integer

  • Specifies the bandwidth (Mbit/s). This parameter is mandatory when type is set to External.
  • The value ranges from 1 to 500.

    (The specific range may vary depending on the configuration in each region. You can see the bandwidth range of each region on the management console.)

admin_state_up

No

Integer/Boolean

  • Specifies the administrative status of the load balancer.
  • Optional values:

    0 or false: indicates that the load balancer is stopped. Only users are allowed to enter the two values.

    1 or true: indicates that the load balancer is running properly.

    2 or false: indicates that the load balancer is frozen. Only the administrator is allowed to enter the two values.

Request

Response

Status Code