setTargetGroupDescription

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

타깃 그룹의 설명을 수정합니다.

구문

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

./ncloud vloadbalancer setTargetGroupDescription \
    --targetGroupNo <target-group-no> \
    [--targetGroupDescription <target-group-description>] \
    [--regionCode <KR|KRS>] \
    [--output <json|xml>]

옵션

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

필수 옵션

setTargetGroupDescription의 필수 옵션입니다.

선택 옵션

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

공통 옵션

vloadbalancer 명령에서 공통으로 사용하는 옵션에 대한 정보는 Load Balancer (VPC) 옵션을 참조해 주십시오.

예시

타깃 그룹 설명 수정 요청이 성공하면 수정된 타깃 그룹의 구성 정보가 반환됩니다.

명령

명령 예시는 다음과 같습니다.

./ncloud vloadbalancer setTargetGroupDescription \
    --targetGroupNo 55667788 \
    --targetGroupDescription "Updated target group description" \
    --regionCode KR \
    --output json

출력

출력 예시는 다음과 같습니다.

{
  "setTargetGroupDescriptionResponse": {
    "totalRows": 1,
    "targetGroupList": [
      {
        "targetGroupNo": "55667788",
        "targetGroupName": "lb-test-tg",
        "targetType": {
          "code": "VSVR",
          "codeName": "Server (VPC)"
        },
        "vpcNo": "12345678",
        "targetGroupProtocolType": {
          "code": "HTTP",
          "codeName": "HTTP protocol"
        },
        "targetGroupPort": 80,
        "targetGroupDescription": "Updated target group description",
        "useStickySession": true,
        "useProxyProtocol": false,
        "algorithmType": {
          "code": "RR",
          "codeName": "Round Robin"
        },
        "createDate": "2026-07-20T17:28:30+0900",
        "regionCode": "KR",
        "loadBalancerInstanceNo": "",
        "healthCheckProtocolType": {
          "code": "HTTP",
          "codeName": "HTTP protocol"
        },
        "healthCheckPort": 8080,
        "healthCheckUrlPath": "/health",
        "healthCheckHttpMethodType": {
          "code": "GET",
          "codeName": "HTTP GET Method"
        },
        "healthCheckCycle": 60,
        "healthCheckUpThreshold": 3,
        "healthCheckDownThreshold": 3,
        "targetNoList": []
      }
    ],
    "requestId": "9690299d-64b3-4730-b7eb-1abbae5f3f1d",
    "returnCode": "0",
    "returnMessage": "success"
  }
}