changeTargetGroupHealthCheckConfiguration

Prev Next

VPC 환경에서 이용 가능합니다.

타깃 그룹의 헬스 체크 설정을 변경합니다.

구문

changeTargetGroupHealthCheckConfiguration 구문은 다음과 같습니다.

./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|KRS>] \
    [--output <json|xml>]

옵션

changeTargetGroupHealthCheckConfiguration 실행 시 지정할 수 있는 옵션을 설명합니다.

필수 옵션

changeTargetGroupHealthCheckConfiguration의 필수 옵션입니다.

옵션 타입 필수 여부 설명
--targetGroupNo String Required 타깃 그룹의 번호
--healthCheckPort Integer Conditional 타깃의 상태를 확인하기 위한 헬스 체크 수행 시 로드밸런서가 사용하는 포트
  • 1~65534
  • 타깃 그룹 헬스 체크 설정 변경 시 healthCheckPort, healthCheckUrlPath, healthCheckHttpMethodTypeCode, healthCheckCycle, healthCheckUpThreshold, healthCheckDownThreshold 중 하나는 필수 입력
--healthCheckUrlPath String Conditional 헬스 체크 수행 시 사용할 URL 경로
  • /로 시작하는 URL 경로
  • 타깃 그룹의 헬스 체크 프로토콜 유형이 HTTP 또는 HTTPS이면 변경 가능
  • 타깃 그룹 헬스 체크 설정 변경 시 healthCheckPort, healthCheckUrlPath, healthCheckHttpMethodTypeCode, healthCheckCycle, healthCheckUpThreshold, healthCheckDownThreshold 중 하나는 필수 입력
--healthCheckHttpMethodTypeCode String Conditional 헬스 체크에 사용할 HTTP 메서드 유형
  • HEAD | GET
  • 타깃 그룹의 헬스 체크 프로토콜 유형이 HTTP 또는 HTTPS이면 변경 가능
  • 타깃 그룹 헬스 체크 설정 변경 시 healthCheckPort, healthCheckUrlPath, healthCheckHttpMethodTypeCode, healthCheckCycle, healthCheckUpThreshold, healthCheckDownThreshold 중 하나는 필수 입력
--healthCheckCycle Integer Conditional 헬스 체크 주기 (초)
  • 5~300
  • 타깃 그룹 헬스 체크 설정 변경 시 healthCheckPort, healthCheckUrlPath, healthCheckHttpMethodTypeCode, healthCheckCycle, healthCheckUpThreshold, healthCheckDownThreshold 중 하나는 필수 입력
--healthCheckUpThreshold Integer Conditional 타깃 상태를 정상이라고 판단하기 위해 필요한 연속적인 헬스 체크 성공 횟수
  • 2~10
  • 타깃 그룹 헬스 체크 설정 변경 시 healthCheckPort, healthCheckUrlPath, healthCheckHttpMethodTypeCode, healthCheckCycle, healthCheckUpThreshold, healthCheckDownThreshold 중 하나는 필수 입력
--healthCheckDownThreshold Integer Conditional 타깃 상태를 비정상이라고 판단하기 위해 필요한 연속적인 헬스 체크 실패 횟수
  • 2~10
  • 타깃 그룹 헬스 체크 설정 변경 시 healthCheckPort, healthCheckUrlPath, healthCheckHttpMethodTypeCode, healthCheckCycle, healthCheckUpThreshold, healthCheckDownThreshold 중 하나는 필수 입력

공통 옵션

vloadbalancer 명령에서 공통으로 사용하는 옵션에 대한 정보는 Load Balancer (VPC) 옵션을 참조해 주십시오.

예시

타깃 그룹 헬스 체크 설정 변경 요청이 성공하면 변경된 타깃 그룹의 구성 정보가 반환됩니다.

명령

명령 예시는 다음과 같습니다.

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

출력

출력 예시는 다음과 같습니다.

{
  "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": "Test target group",
        "useStickySession": true,
        "useProxyProtocol": false,
        "algorithmType": {
          "code": "RR",
          "codeName": "Round Robin"
        },
        "createDate": "2026-07-20T17:28:30+0900",
        "regionCode": "KR",
        "loadBalancerInstanceNo": "",
        "healthCheckProtocolType": {
          "code": "HTTP",
          "codeName": "HTTP protocol"
        },
        "healthCheckPort": 8080,
        "healthCheckUrlPath": "/health",
        "healthCheckHttpMethodType": {
          "code": "GET",
          "codeName": "HTTP GET Method"
        },
        "healthCheckCycle": 60,
        "healthCheckUpThreshold": 3,
        "healthCheckDownThreshold": 3,
        "targetNoList": []
      }
    ],
    "requestId": "e3173ff5-2d85-4039-8c9e-40e6548cd767",
    "returnCode": "0",
    "returnMessage": "success"
  }
}