setServerInstanceHealth

개요

서버 인스턴스 헬스 상태 갱신

설명

사용자가 보유하는 오토 스케일링 그룹 소속의 서버 인스턴스의 헬스 상태를 설정할 수 있습니다.

요청 파라미터

파라미터 명	필수 여부	타입	제약사항	설명
serverInstanceNo	Yes	String	-	- 서버 인스턴스의 식별 번호 회원의 오토 스케일링 그룹 소속 서버 인스턴스가 아니면 유효하지 않음
healthStatusCode	Yes	String	Min : 1, Max : 5	- 헬스 상태 코드 유효 값 HEALTHY(HLTHY)와 UNHEALTHY(UNHTH)가 있음 전술한 괄호 안의 코드 값을 사용할 것, 서버 인스턴스가 생성되고 나서 서비스에 투입된 이후에만 가능
shouldRespectGracePeriod	No	Boolean	-	헬스 체크 보류 기간(healthCheckGracePeriod) 준수 여부를 true/false로 입력 서버 인스턴스가 생성되고 나서 서비스에 투입된 시각에서 healthCheckGracePeriod 기간이 지나지 않으면 unhealthy 상태로 변경하려 해도 적용되지 않음 디폴트로 그 보류 기간을 준수함 그 값이 False이면, 그 보류 기간을 준수하지 않음

응답 데이터 타입

CommonResponse 타입

CommonResponse extends BaseObject
private String requestId;
private String returnCode;
private String returnMessage;

예시

호출

ncloud autoscaling setServerInstanceHealth --serverInstanceNo 396463 --healthStatusCode HLTHY

응답

{
  "setServerInstanceHealthResponse": {
    "requestId": "e6715629-bf2c-4991-b2ea-a7606f2fe488",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<setServerInstanceHealthResponse>
  <requestId>e6715629-bf2c-4991-b2ea-a7606f2fe488</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
</setServerInstanceHealthResponse>