---
title: "setTargetGroupDescription"
slug: "cli-vloadbalancer-targetgroup-settargetgroupdescription"
tags: ["Load Balancer", "VPC"]
updated: 2026-09-17T09:16:08Z
published: 2026-09-17T09:16:08Z
canonical: "cli.ncloud-docs.com/cli-vloadbalancer-targetgroup-settargetgroupdescription"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://cli.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# setTargetGroupDescription

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

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

## 구문

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

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

## 옵션

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

### 필수 옵션

`setTargetGroupDescription`의 필수 옵션입니다.

| 옵션 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `--targetGroupNo` | String | Required | 타깃 그룹의 번호 - [getTargetGroupList](/docs/cli-vloadbalancer-targetgroup-gettargetgrouplist) 참조 |

### 선택 옵션

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

| 옵션 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `--targetGroupDescription` | String | Optional | 타깃 그룹에 대한 설명 (Byte) - 0~1,000 |

### 공통 옵션

`vloadbalancer` 명령에서 공통으로 사용하는 옵션에 대한 정보는 [Load Balancer (VPC) 옵션](/docs/cli-vloadbalancer#%EC%98%B5%EC%85%98)을 참조해 주십시오.

## 예시

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

### 명령

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

```
./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-07T17:08:44+0900",
        "regionCode": "KR",
        "loadBalancerInstanceNo": "41112223",
        "healthCheckProtocolType": {
          "code": "HTTP",
          "codeName": "HTTP protocol"
        },
        "healthCheckPort": 80,
        "healthCheckUrlPath": "/",
        "healthCheckHttpMethodType": {
          "code": "GET",
          "codeName": "HTTP GET Method"
        },
        "healthCheckCycle": 30,
        "healthCheckUpThreshold": 2,
        "healthCheckDownThreshold": 2,
        "targetNoList": [
          "34567890"
        ]
      }
    ],
    "requestId": "f6a7b8c9-d0e1-2345-fabc-678901234567",
    "returnCode": "0",
    "returnMessage": "success"
  }
}
```