setTargetGroupDescription

VPC環境で利用できます。

ターゲットグループの説明を変更します。

構文

setTargetGroupDescription構文は次の通りです。

./ncloud vloadbalancer setTargetGroupDescription \
    --targetGroupNo <target-group-no> \
    [--targetGroupDescription <target-group-description>] \
    [--regionCode <KR|SGN|JPN>] \
    [--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-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"
  }
}