changeTargetGroupHealthCheckConfiguration

Available in VPC

Change target group's health check settings.

Syntax

The changeTargetGroupHealthCheckConfiguration syntax is as follows:

./ncloud vloadbalancer changeTargetGroupHealthCheckConfiguration \
    --targetGroupNo <target-group-no> \
    [--healthCheckPort <health-check-port>] \
    [--healthCheckUrlPath <health-check-url-path>] \
    [--healthCheckHttpMethodTypeCode <HEAD|GET>] \
    [--healthCheckCycle <health-check-cycle>] \
    [--healthCheckUpThreshold <health-check-up-threshold>] \
    [--healthCheckDownThreshold <health-check-down-threshold>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running changeTargetGroupHealthCheckConfiguration.

Required options

The following options are required for changeTargetGroupHealthCheckConfiguration.

Options	Type	Required	Description
`--targetGroupNo`	String	Required	Target group number See getTargetGroupList.
`--healthCheckPort`	Integer	Conditional	Port used by the load balancer when performing health checks to verify the status of targets `1`-`65534` When changing target group health check settings, one of the following is required: `healthCheckPort`, `healthCheckUrlPath`, `healthCheckHttpMethodTypeCode`, `healthCheckCycle`, `healthCheckUpThreshold`, or `healthCheckDownThreshold`.
`--healthCheckUrlPath`	String	Conditional	URL path to use when performing a health check URL path starting with `/`. Can be changed if the target group's health check protocol type is `HTTP` or `HTTPS`. When changing the target group's health check settings, at least one among `healthCheckPort`, `healthCheckUrlPath`, `healthCheckHttpMethodTypeCode`, `healthCheckCycle`, `healthCheckUpThreshold`, or `healthCheckDownThreshold` must be entered.
`--healthCheckHttpMethodTypeCode`	String	Conditional	HTTP method type used for health checks `HEAD` \| `GET` Can be changed if the target group's health check protocol type is `HTTP` or `HTTPS`. When changing target group health check settings, at least one among `healthCheckPort`, `healthCheckUrlPath`, `healthCheckHttpMethodTypeCode`, `healthCheckCycle`, `healthCheckUpThreshold`, or `healthCheckDownThreshold` must be entered.
`--healthCheckCycle`	Integer	Conditional	Health check interval (second) `5`-`300` When changing the target group health check settings, at least one among `healthCheckPort`, `healthCheckUrlPath`, `healthCheckHttpMethodTypeCode`, `healthCheckCycle`, `healthCheckUpThreshold`, or `healthCheckDownThreshold` must be entered.
`--healthCheckUpThreshold`	Integer	Conditional	Number of consecutive successful health checks required to determine that the target is in a normal state `2`-`10` When changing the target group health check settings, at least one among `healthCheckPort`, `healthCheckUrlPath`, `healthCheckHttpMethodTypeCode`, `healthCheckCycle`, `healthCheckUpThreshold`, or `healthCheckDownThreshold` must be entered.
`--healthCheckDownThreshold`	Integer	Conditional	Number of consecutive health check failures required to determine that the target status is abnormal `2`-`10` When changing the target group health check settings, at least one among `healthCheckPort`, `healthCheckUrlPath`, `healthCheckHttpMethodTypeCode`, `healthCheckCycle`, `healthCheckUpThreshold`, or `healthCheckDownThreshold` 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 health check settings is successful, the configuration information for the modified target group is returned.

Command

The command example is as follows:

./ncloud vloadbalancer changeTargetGroupHealthCheckConfiguration \
    --targetGroupNo 55667788 \
    --healthCheckPort 8080 \
    --healthCheckUrlPath /health \
    --healthCheckHttpMethodTypeCode GET \
    --healthCheckCycle 60 \
    --healthCheckUpThreshold 3 \
    --healthCheckDownThreshold 3 \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "changeTargetGroupHealthCheckConfigurationResponse": {
    "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": 8080,
        "healthCheckUrlPath": "/health",
        "healthCheckHttpMethodType": {
          "code": "GET",
          "codeName": "HTTP GET Method"
        },
        "healthCheckCycle": 60,
        "healthCheckUpThreshold": 3,
        "healthCheckDownThreshold": 3,
        "targetNoList": [
          "34567890"
        ]
      }
    ],
    "requestId": "e5f6a7b8-c9d0-1234-efab-567890123456",
    "returnCode": "0",
    "returnMessage": "success"
  }
}