setLoadBalancerDescription

Prev Next

VPC 환경에서 이용 가능합니다.

로드밸런서의 설명을 수정합니다.

구문

setLoadBalancerDescription 구문은 다음과 같습니다.

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

옵션

setLoadBalancerDescription 실행 시 지정할 수 있는 옵션을 설명합니다.

필수 옵션

setLoadBalancerDescription의 필수 옵션입니다.

옵션 타입 필수 여부 설명
--loadBalancerInstanceNo String Required 로드밸런서 인스턴스 번호

선택 옵션

setLoadBalancerDescription의 선택 옵션입니다. 지정하지 않은 옵션에는 기본값이 적용됩니다.

옵션 타입 필수 여부 설명
--loadBalancerDescription String Optional 로드밸런서에 대한 설명 (Byte)
  • 0~1,000

공통 옵션

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-21T10:51:04+0900",
        "loadBalancerName": "lb-test-01",
        "loadBalancerDomain": "lb-test-01-41112223-8839ccafe6cb.kr-gov.lb.naverncp.com",
        "loadBalancerIpList": [
          "10.0.1.6"
        ],
        "loadBalancerType": {
          "code": "APPLICATION",
          "codeName": "Application Load Balancer"
        },
        "loadBalancerNetworkType": {
          "code": "PRIVATE",
          "codeName": "Private"
        },
        "throughputType": {
          "code": "SMALL",
          "codeName": "Small"
        },
        "idleTimeout": 120,
        "vpcNo": "12345678",
        "regionCode": "KR",
        "accessLogUseYn": "N",
        "subnetNoList": [
          "23456789"
        ],
        "loadBalancerSubnetList": [
          {
            "zoneCode": "KR-1",
            "subnetNo": "23456789",
            "publicIpInstanceNo": ""
          }
        ],
        "loadBalancerListenerNoList": [
          "60001111",
          "60002222"
        ]
      }
    ],
    "requestId": "a5a05b2d-5008-45e4-be93-b8b644afb601",
    "returnCode": "0",
    "returnMessage": "success"
  }
}