changeTargetGroupHealthCheckConfiguration

Prev Next

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

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

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
GET /changeTargetGroupHealthCheckConfiguration

요청 헤더

Load Balancer API에서 공통으로 사용하는 헤더에 대한 자세한 내용은 Load Balancer 공통 헤더를 참조해 주십시오.

요청 쿼리 파라미터

파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
regionCode String Optional 헬스 체크 설정을 변경하려는 타깃 그룹의 리전
  • getRegionList 조회 결과의 첫 번째 리전(기본값)
  • getRegionList를 통해 확인
targetGroupNo String Required 타깃 그룹의 번호
healthCheckPort Integer Conditional 타깃의 상태를 확인하기 위한 헬스 체크 수행 시 로드 밸런서가 사용하는 포트
  • 1~65534 (기본값: 80)
healthCheckUrlPath String Conditional 헬스 체크 수행 시 사용할 URL 경로
  • /로 시작하는 URL 경로 입력
  • 타깃 그룹의 헬스 체크 프로토콜 유형이 HTTP 또는 HTTPS이면 변경 가능
healthCheckHttpMethodTypeCode String Conditional 헬스 체크에 사용할 HTTP 메서드 유형
  • HEAD | GET
  • 선택한 타깃 그룹의 헬스 체크 프로토콜 유형이 HTTP 또는 HTTPS이면 변경 가능
healthCheckCycle Integer Conditional 헬스 체크 주기(초)
  • 5~300
healthCheckUpThreshold Integer Conditional 타깃 상태를 정상이라고 판단하기 위해 필요한 연속적인 헬스 체크 성공 횟수
  • 2~10
healthCheckDownThreshold Integer Conditional 타깃 상태를 비정상이라고 판단하기 위해 필요한 연속적인 헬스 체크 실패 횟수
  • 2~10
responseFormatType String Optional 응답 결과의 형식
  • xml (기본값) | json

요청 예시

요청 예시는 다음과 같습니다.

curl --location 'https://ncloud.apigw.gov-ntruss.com/vloadbalancer/v2/changeTargetGroupHealthCheckConfiguration
?regionCode=KR
&targetGroupNo=*******
&healthCheckPort=80
&healthCheckUrlPath=/
&healthCheckHttpMethodTypeCode=GET
&healthCheckCycle=30
&healthCheckUpThreshold=2
&healthCheckDownThreshold=2'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디는 TargetGroupList를 참조해 주십시오.

응답 상태 코드

네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 Ncloud API 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

<changeTargetGroupHealthCheckConfigurationResponse>
    <requestId>3a30cb81-63af-4565-b38b-55d01c9f777d</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <targetGroupList>
        <targetGroup>
            <targetGroupNo>*******</targetGroupNo>
            <targetGroupName>test-*****</targetGroupName>
            <targetType>
                <code>VSVR</code>
                <codeName>Server (VPC)</codeName>
            </targetType>
            <vpcNo>*****</vpcNo>
            <targetGroupProtocolType>
                <code>HTTP</code>
                <codeName>HTTP protocol</codeName>
            </targetGroupProtocolType>
            <targetGroupPort>80</targetGroupPort>
            <targetGroupDescription></targetGroupDescription>
            <useStickySession>false</useStickySession>
            <useProxyProtocol>false</useProxyProtocol>
            <algorithmType>
                <code>RR</code>
                <codeName>Round Robin</codeName>
            </algorithmType>
            <createDate>2024-06-03T13:30:20+0900</createDate>
            <regionCode>KR</regionCode>
            <loadBalancerInstanceNo></loadBalancerInstanceNo>
            <healthCheckProtocolType>
                <code>HTTP</code>
                <codeName>HTTP protocol</codeName>
            </healthCheckProtocolType>
            <healthCheckPort>80</healthCheckPort>
            <healthCheckUrlPath>/</healthCheckUrlPath>
            <healthCheckHttpMethodType>
                <code>GET</code>
                <codeName>HTTP GET Method</codeName>
            </healthCheckHttpMethodType>
            <healthCheckCycle>30</healthCheckCycle>
            <healthCheckUpThreshold>2</healthCheckUpThreshold>
            <healthCheckDownThreshold>2</healthCheckDownThreshold>
            <targetNoList/>
        </targetGroup>
    </targetGroupList>
</changeTargetGroupHealthCheckConfigurationResponse>