setLoadBalancerDescription

VPC環境で利用できます。

ロードバランサの説明を変更します。

構文

setLoadBalancerDescription構文は次の通りです。

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

オプション

setLoadBalancerDescriptionの実行時に指定できるオプションについて説明します。

必須オプション

setLoadBalancerDescriptionの必須オプションです。

任意オプション

setLoadBalancerDescriptionの任意オプションです。指定しない場合、オプションにはデフォルト値が適用されます。

共通オプション

vloadbalancerコマンドで共通して使用するオプションについては、Load Balancer (VPC)のオプションをご参照ください。

例

ロードバランサの説明の変更リクエストが成功すると、変更後のインスタンスの構成情報が返されます。

コマンド

コマンドの例は次の通りです。

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

出力

出力の例は次の通りです。

{
  "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"
  }
}