changeTargetGroupConfiguration

Prev Next

Available in VPC

Change target group settings.

Syntax

The changeTargetGroupConfiguration syntax is as follows:

./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>]

Options

This section describes the options available when running changeTargetGroupConfiguration.

Required options

The following options are required for changeTargetGroupConfiguration.

Options Type Required Description
--targetGroupNo String Required Target group number
--useStickySession Boolean Conditional Whether to use per-session access
  • true | false
    • true: Enabled.
    • false: Disabled.
  • Can be set if the target group's protocol type is TCP, UDP, HTTP, or HTTPS.
  • When changing target group settings, at least one among useStickySession, useProxyProtocol, or algorithmTypeCode must be entered.
--useProxyProtocol Boolean Conditional Proxy protocol usage
  • true | false
    • true: Enabled.
    • false: Disabled.
  • Can be set if the target group’s protocol type is PROXY_TCP.
  • When changing the target group settings, at least one among useStickySession, useProxyProtocol, or algorithmTypeCode must be entered.
--algorithmTypeCode String Conditional Load balancing algorithm type
  • RR | SIPHS | LC | MH
    • RR: Round robin.
    • SIPHS: Source IP hash.
    • LC: Least connection.
    • MH: Maglev hash.
  • Available values are limited depending on the target group’s protocol type.
    • HTTP, HTTPS, PROXY_TCP protocols: RR | SIPHS | LC
    • TCP, UDP protocols: RR | MH
  • When changing target group settings, at least one among useStickySession, useProxyProtocol, or algorithmTypeCode must be entered.

Common options

For information about the options common to all vloadbalancer subcommands, see Load Balancer (VPC) options.

Examples

If the request to change the target group settings is successful, the configuration information for the updated target group is returned.

Command

The command example is as follows:

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

Output

The output example is as follows:

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