setTargetGroupDescription

Available in VPC

Edit the target group description.

Syntax

The setTargetGroupDescription syntax is as follows:

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

Options

This section describes the options available when running setTargetGroupDescription.

Required options

The following options are required for setTargetGroupDescription.

Options	Type	Required	Description
`--targetGroupNo`	String	Required	Target group number See getTargetGroupList.

Optional options

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

Options	Type	Required	Description
`--targetGroupDescription`	String	Optional	Description of the target group (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 target group description is successful, the configuration information for the edited target group is returned.

Command

The command example is as follows:

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

Output

The output example is as follows:

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