changeTargetGroupConfiguration

VPC環境で利用できます。

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

構文

changeTargetGroupConfiguration構文は次の通りです。

./ncloud vloadbalancer changeTargetGroupConfiguration \
    --targetGroupNo <target-group-no> \
    [--useStickySession <true|false>] | [--useProxyProtocol <true|false>] \
    [--algorithmTypeCode <RR|SIPHS|LC|MH>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

オプション

changeTargetGroupConfigurationの実行時に指定できるオプションについて説明します。

必須オプション

changeTargetGroupConfigurationの必須オプションです。

オプション	タイプ	必須の有無	説明
`--targetGroupNo`	String	Required	ターゲットグループの番号 getTargetGroupListを参照
`--useStickySession`	Boolean	Conditional	セッションごとのアクセス使用 `true` \| `false` `true`: 使用 `false`: 使用しないターゲットグループのプロトコルタイプが`TCP`、`UDP`、`HTTP`または`HTTPS`の場合、設定可能ターゲットグループ設定変更時、`useStickySession`、`useProxyProtocol`、`algorithmTypeCode`のいずれかは必ず入力
`--useProxyProtocol`	Boolean	Conditional	プロキシプロトコルを使用するか `true` \| `false` `true`: 使用 `false`: 使用しないターゲットグループのプロトコルタイプが`PROXY_TCP`の場合、設定可能ターゲットグループ設定変更時は、`useStickySession`、`useProxyProtocol`、`algorithmTypeCode`のうち、いずれかを必ず入力
`--algorithmTypeCode`	String	Conditional	ロードバランシングに使用するアルゴリズムのタイプ `RR` \| `SIPHS` \| `LC` \| `MH` `RR`: Round Robin `SIPHS`: Source IP Hash `LC`: Least Connection `MH`: Maglev Hash ターゲットグループのプロトコルタイプに応じて、設定可能な値が制限される `HTTP`、`HTTPS`、`PROXY_TCP`プロトコル: `RR` \| `SIPHS` \| `LC` `TCP`、`UDP`プロトコル: `RR` \| `MH` ターゲットグループの設定時、`useStickySession`、`useProxyProtocol`、`algorithmTypeCode`のいずれかは必ず入力

共通オプション

vloadbalancerコマンドで共通して使用するオプションについては、Load Balancer (VPC)のオプションをご参照ください。

例

ターゲットグループ設定の変更リクエストが成功すると、変更後のターゲットグループの構成情報が返されます。

コマンド

コマンドの例は次の通りです。

./ncloud vloadbalancer changeTargetGroupConfiguration \
    --targetGroupNo 55667788 \
    --useStickySession true \
    --algorithmTypeCode RR \
    --regionCode KR \
    --output json

出力

出力の例は次の通りです。

{
  "changeTargetGroupConfigurationResponse": {
    "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": "Test target group",
        "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": "d4e5f6a7-b8c9-0123-defa-456789012345",
    "returnCode": "0",
    "returnMessage": "success"
  }
}