setLoadBalancerDescription

Available in VPC

Edit load balancer description.

Syntax

The setLoadBalancerDescription syntax is as follows:

./ncloud vloadbalancer setLoadBalancerDescription \
    --loadBalancerInstanceNo <load-balancer-instance-no> \
    [--loadBalancerDescription <load-balancer-description>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running setLoadBalancerDescription.

Required options

The following options are required for setLoadBalancerDescription.

Options	Type	Required	Description
`--loadBalancerInstanceNo`	String	Required	Load balancer instance number See getLoadBalancerInstanceList.

Optional options

These are the optional options for setLoadBalancerDescription. Options that are not specified will use their default values.

Options	Type	Required	Description
`--loadBalancerDescription`	String	Optional	Load balancer description (byte) 0-1000

Common options

For information about the options common to all vloadbalancer subcommands, see Load Balancer (VPC) options.

Examples

If the request to edit the load balancer description is successful, the configuration information for the edited instance is returned.

Command

The command example is as follows:

./ncloud vloadbalancer setLoadBalancerDescription \
    --loadBalancerInstanceNo 41112223 \
    --loadBalancerDescription "Updated load balancer description" \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "changeLoadBalancerInstanceConfigurationResponse": {
    "totalRows": 1,
    "loadBalancerInstanceList": [
      {
        "loadBalancerInstanceNo": "41112223",
        "loadBalancerInstanceStatus": {
          "code": "USED",
          "codeName": "LB USED state"
        },
        "loadBalancerInstanceOperation": {
          "code": "NULL",
          "codeName": "LB NULL OP"
        },
        "loadBalancerInstanceStatusName": "Running",
        "loadBalancerDescription": "Updated load balancer description",
        "createDate": "2026-07-07T17:12:11+0900",
        "loadBalancerName": "lb-test-01",
        "loadBalancerDomain": "lb-test-01-41112223-16dd7a5738c1.kr.lb.naverncp.com",
        "loadBalancerIpList": [
          "10.0.2.6"
        ],
        "loadBalancerType": {
          "code": "APPLICATION",
          "codeName": "Application Load Balancer"
        },
        "loadBalancerNetworkType": {
          "code": "PRIVATE",
          "codeName": "Private"
        },
        "throughputType": {
          "code": "SMALL",
          "codeName": "Small"
        },
        "idleTimeout": 60,
        "vpcNo": "12345678",
        "regionCode": "KR",
        "accessLogUseYn": "N",
        "subnetNoList": [
          "23456790"
        ],
        "loadBalancerSubnetList": [
          {
            "zoneCode": "KR-1",
            "subnetNo": "23456790",
            "publicIpInstanceNo": ""
          }
        ],
        "loadBalancerListenerNoList": [
          "60001111"
        ]
      }
    ],
    "requestId": "e5f6a7b8-c9d0-1234-efab-567890123456",
    "returnCode": "0",
    "returnMessage": "success"
  }
}