putScalingPolicy

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

VPC環境で利用できます。

概要

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 KR --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>

この記事は役に立ちましたか?

What's Next

deleteScalingPolicy

概要
リクエスト
レスポンス
例

タグ