Documentation Index

Fetch the complete documentation index at: https://cli.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

changeTargetGroupHealthCheckConfiguration

Prev Next

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

개요

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

요청

요청 파라미터

파라미터명 필수 여부 타입 제약 사항 설명
regionCode No String - 리전 코드
헬스 체크 설정을 변경할 타겟 그룹의 리전(Region) 결정 가능
regionCode는 getRegionList 액션을 통해 획득 가능
Default : getRegionList 조회 결과의 첫 번째 리전을 선택
targetGroupNo Yes String - 헬스 체크 설정을 변경할 타겟 그룹 번호
targetGroupNo는 getTargetGroupList 액션을 통해 획득 가능
healthCheckPort Conditional Integer Min : 1, Max : 65534 - 헬스 체크 포트
헬스 체크에 사용할 포트 변경 가능
healthCheckUrlPath Conditional String - 헬스 체크 URL 경로
헬스 체크에 사용할 URL 경로 변경 가능
선택한 타겟 그룹의 헬스 체크 프로토콜 유형이 HTTP 또는 HTTPS 인 경우에만 변경 가능
/ 문자로 시작하는 URL 경로 입력
healthCheckHttpMethodTypeCode Conditional String - 헬스 체크 HTTP Method 유형 코드
헬스 체크에 사용할 HTTP Method 변경 가능
선택한 타겟 그룹의 헬스 체크 프로토콜 유형이 HTTP 또는 HTTPS 인 경우에만 변경 가능
Options : HEAD | GET
healthCheckCycle Conditional Integer Min : 5, Max : 300 초 - 헬스 체크 주기
헬스 체크 주기 변경 가능
healthCheckUpThreshold Conditional Integer Min : 2, Max : 10 - 헬스 체크 정상 임계값
헬스 체크를 정상 상태로 간주하기까지 필요한 연속적인 상태 확인 성공 횟수를 변경 할 수 있음
healthCheckDownThreshold Conditional Integer Min : 2, Max : 10 - 헬스 체크 실패 임계값
헬스 체크를 실패 상태로 간주하기까지 필요한 연속적인 상태 확인 실패 횟수를 변경 할 수 있음
responseFormatType No String - 응답 결과의 포맷 타입
Options : xml | json
Default : xml

응답

응답 데이터 타입

  • TargetGroupList 타입
TargetGroupList extends CommonResponse
private Integer totalRows;
private List targetGroupList = new ArrayList<>();
TargetGroup
private String targetGroupNo;
private String targetGroupName;
private CommonCode targetType;
private String vpcNo;
private CommonCode targetGroupProtocolType;
private Integer targetGroupPort;
private String targetGroupDescription;
private Boolean useStickySession;
private Boolean useProxyProtocol;
private CommonCode algorithmType;
private Date createDate;
private String regionCode;
private String loadBalancerInstanceNo;
private CommonCode healthCheckProtocolType;
private Integer healthCheckPort;
private String healthCheckUrlPath;
private CommonCode healthCheckHttpMethodType;
private Integer healthCheckCycle;
private Integer healthCheckUpThreshold;
private Integer healthCheckDownThreshold;
private TargetNoList targetNoList;
TargetNoList
private List targetNoList = new ArrayList<>();

예시

요청 예시

ncloud vloadbalancer changeTargetGroupHealthCheckConfiguration --regionCode KR --targetGroupNo ***095 --healthCheckPort 80 --healthCheckUrlPath "/" --healthCheckHttpMethodTypeCode GET --healthCheckCycle 30 --healthCheckUpThreshold 2 --healthCheckDownThreshold 2

응답 예시

<changeTargetGroupHealthCheckConfigurationResponse>
  <requestId>b644e5ed-6ca8-48d5-9b7f-2a3549ef3c96</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <targetGroupList>
    <targetGroup>
      <targetGroupNo>***095</targetGroupNo>
      <targetGroupName>test-***</targetGroupName>
      <targetType>
        <code>VSVR</code>
        <codeName>Server (VPC)</codeName>
      </targetType>
      <vpcNo>***04</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>2020-12-17T21:06:45+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>get</codeName>
      </healthCheckHttpMethodType>
      <healthCheckCycle>30</healthCheckCycle>
      <healthCheckUpThreshold>2</healthCheckUpThreshold>
      <healthCheckDownThreshold>2</healthCheckDownThreshold>
      <targetNoList/>
    </targetGroup>
  </targetGroupList>
</changeTargetGroupHealthCheckConfigurationResponse>