putScalingPolicy

Prev Next

개요

스케일링 정책 생성/변경

설명

Scaling 정책(policy)을 생성하거나 변경합니다. 정책 수행을 요청하면 설정된 정책에 따라 scale-in 또는 scale-out action을 수행합니다.

요청 파라미터

파라미터 명 필수 여부 타입 제약사항 설명
policyName Yes String Min : 1, Max : 255 - 정책 이름, 스케일링 정책의 식별자
특정 Auto Scaling Group 소속이며 그 범위 안에서는 이 이름이 중복 생성될 수 없음
이 api를 호출했을 때 지정된 Auto Scaling Group의 범위 안에서 정책 이름이 없다면 생성을 하고, 이미 존재한다면 그 내용을 변경함
하나의 Auto Scaling Group 당 최대 10개의 정책을 생성할 수 있음
autoScalingGroupName Yes String Min : 1, Max : 255 정책이 수행될 오토 스케일링 그룹명 입력
adjustmentTypeCode Yes String Min : 1, Max : 5 - Group의 capacity를 조정하는 유형 코드
다음과 같이 3개의 코드가 유효 (괄호 안이 입력 가능한 코드 값)
* ChangeInCapacity(CHANG): 아래 수식과 같이 capacity가 지정된 값만큼 변경됨
수식) (new desired capacity) = (current actual capacity) + (scalingAdjustment of ChangeInCapacity type)
* ExactCapacity(EXACT): capacity가 지정된 값으로 변경됨
수식) (new desired capacity) = (scalingAdjustment of ExactCapacity type)
* PercentChangeInCapacity(PRCNT) : capacity가 지정된 perecent 값만큼 변경됨
수식) (new desired capacity) = (current actual capacity) + (current actual capacity) X (scalingAdjustment of PercentChangeInCapacity type) / 100
scalingAdjustment Yes Integer Min: -2147483647, Max : 2147483647 - 스케일링을 위한 Group capacity 조정 값
adjustmentTypeCode 값이 ChangeInCapacity(CHANG) 또는 PercentChangeInCapacity(PRCNT) 유형일 때
i ) scalingAdjustment가 양수이면 capacity가 증가해서 scale-out
ii) scalingAdjustment가 음수이면 capacity가 감소해서 scale-in
PercentChangeInCapacity(PRCNT) 유형의 scalingAdjustment의 최소 값은 -100
cooldown No Integer Min:0, Max:2147483647 스케일링 액션 종료 이후 cooldown 시간 동안은 알람 통보를 받아도 무시
minAdjustmentStep No Integer Min:1, Max:2147483647 - 최소 조정 폭(step)
adjustmentTypeCode 유형이 PercentChangeInCapacity(PRCNT)일 때만 지정 가능 (따라서 지정 안 하는 것도 가능)
다른 유형 값일 경우는 지정이 안됨
PercentChangeInCapacity(PRCNT) 유형일 때 scalingAdjustment에 의한 변경량(change)이 minAdjustmentStep 보다 작으면 변경량을 minAdjustmentStep으로 세팅함

응답 데이터 타입

  • CommonResponse 타입
CommonResponse extends BaseObject
private String requestId;
private String returnCode;
private String returnMessage;

예시

호출

ncloud autoscaling putScalingPolicy --policyName test-autoscaling-policy --autoScalingGroupName soso02 --adjustmentTypeCode EXACT --scalingAdjustment 22

응답

{
  "putScalingPolicyResponse": {
    "requestId": "e824e13a-c339-45cf-8192-e28b34a6765f",
    "returnCode": "0",
    "returnMessage": "success"
  }
}
<?xml version="1.0" encoding="UTF-8" ?>
<putScalingPolicyResponse>
  <requestId>e824e13a-c339-45cf-8192-e28b34a6765f</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
</putScalingPolicyResponse>