putScalingPolicy

개요

Scaling 정책을 생성 또는 수정합니다.

요청

요청 파라미터

파라미터명	필수 여부	타입	제약 사항	설명
regionCode	No	String		- 리전 코드 Scaling 정책을 생성 또는 수정할 Auto Scaling Group의 리전(Region) 결정 가능 regionCode는 getRegionList 액션을 통해 획득 가능 Default : getRegionList 조회 결과의 첫 번째 리전을 선택
autoScalingGroupNo	Yes	String		- Auto Scaling Group 번호 autoScalingGroupNo는 getAutoScalingGroupList 액션을 통해 획득 가능
policyNo	Conditional	String		- 수정할 Scaling 정책 번호 Scaling 정책 번호를 이용하여 수정할 정책 지정 가능 새로운 Scaling 정책을 생성하는 경우에는 입력하지 않음 수정하는 경우 policyNo와 policyName 중 반드시 한개를 필수로 입력함 policyNo는 getAutoScalingPolicyList 액션을 통해 획득 가능
policyName	Conditional	String	Min : 1, Max : 255 소문자, 숫자, "-"의 특수문자만 허용하며 알파벳 문자로 시작해야 함 영어 또는 숫자로 끝나야 함	- Scaling 정책 이름 새로 생성할 Scaling 정책 이름을 입력하거나 수정할 Scaling 정책 이름 입력 가능 지정한 이름의 Scaling 정책이 이미 존재하는경우 해당 Scaling 정책의 내용이 수정됨 수정하는 경우 policyNo와 policyName 중 반드시 한개를 필수로 입력함 생성하는 경우에는 policyName을 필수로 입력함 policyName는 getAutoScalingPolicyList 액션을 통해 획득 가능
adjustmentTypeCode	Yes	String		- 조정 유형 코드 Scaling 정책이 수행될 때 서버의 대수가 조정되는 방식을 결정함 Options : `CHANG (Change In Capacity (증감변경))` : 현재 그룹 크기와 상관없이 지정한 서버 대수를 직접 추가 또는 삭제하는 방법 `PRCNT (Percent Change In Capacity (비율변경)` : 현재 그룹 크기 대비 일정한 비율(%)로 서버를 증감시키는 방법 `EXACT (Exact Capacity (고정값))` : 그룹 크기를 지정한 값으로 고정시키는 방법 adjustmentTypeCode는 getAdjustmentTypeList 액션을 통해 획득 가능
scalingAdjustment	Yes	Integer	Min: adjustmentTypeCode에 따라서 최소값 범위가 달라짐 CHANG : -2147483648 PRCNT : -100 EXACT : 0 Max : 2147483647	- 조정값 조정 유형에 맞는 조정값을 지정함 adjustmentTypeCode 가 CHANG 또는 PRCNT 일때 감소시키려면 음수의 값을 입력함 조정 유형에 따라서 단위가 (대) 또는 (%) 가 될 수 있음
minAdjustmentStep	No	Integer	Min: 1, Max : 2147483647	- 최소 조정 폭 최소 조정 폭 만큼 서버 인스턴스 수를 변경함 adjustmentTypeCode 가 PRCNT 일때만 유효함
coolDown	No	Integer	Min: 0, Max : 2147483647	- 쿨다운 새로운 서버가 생성되었다고 해도, 초기화 스크립트 실행이나 업데이트 설치 등의 이유로 실제 서비스를 수행할 수 있을 정도로 준비되기까지는 시간이 소요될 수 있음 쿨다운(Cooldown) 시간이란 실제 Scaling이 수행 중이거나 수행 완료된 이후에 모니터링 이벤트 알람이 발생하더라도 반응하지 않고 무시하도록 설정한 기간 Default : 300 초
responseFormatType	No	String		- 응답 결과의 포맷 타입 Options : xml \| json Default : xml

응답

응답 데이터 타입

ScalingPolicyList 타입

ScalingPolicyList extends CommonResponse
private Integer totalRows;
private List scalingPolicyList = new ArrayList<>();

ScalingPolicy
private String autoScalingGroupNo;
private String policyNo;
private String policyName;
private CommonCode adjustmentType;
private Integer scalingAdjustment;
private Integer minAdjustmentStep;
private Integer coolDown;

예시

요청 예시

ncloud vautoscaling putScalingPolicy --regionCode FKR --autoScalingGroupNo ***700 --policyName test-*** --adjustmentTypeCode CHANG --scalingAdjustment 1 --coolDown 300 --timeZone KST

응답 예시

<putScalingPolicyResponse>
  <requestId>dcbf41de-b9d4-460d-a594-60d77ec25bf1</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <scalingPolicyList>
      <scalingPolicy>
        <autoScalingGroupNo>***700</autoScalingGroupNo>
        <policyNo>***922</policyNo>
        <policyName>test-***</policyName>
        <adjustmentType>
          <code>CHANG</code>
          <codeName>ChangeInCapacity</codeName>
        </adjustmentType>
        <scalingAdjustment>1</scalingAdjustment>
        <coolDown>300</coolDown>
      </scalingPolicy>
    </scalingPolicyList>
</putScalingPolicyResponse>