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 ポリシーが実行されるAuto Scaling Group名を入力します。
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>