updateAutoScalingGroup

VPC環境で利用できます。

概要

Auto Scaling Groupの詳細情報と設定されたLaunch Configurationを修正します。
指定されたパラメータに該当するプロパティに限ってその値が修正され、伝達されなかったパラメータに該当するプロパティは既存の値のままで維持されます。
選択的パラメータをすべて入力しないと、修正されていない結果が照会されます。 (エラーは発生しません。)
このアクション(Action)の呼び出しによってminSize、desiredCapacityまたはmaxSizeが変更されても、その大小関係は変わらず維持されなければなりません。 (minSize <= desiredCapacity <= maxSize)
このアクション(Action)の呼び出しで新しいLaunch Configurationが指定されると、その後にサーバインスタンスが作成される時に効果が現れます。
Auto Scaling Groupが現在Scaling Actionを実行している状態で呼び出すと、エラーが発生します。

リクエスト

リクエストパラメータ

パラメータ名	必須有無	タイプ	制約事項	説明
regionCode	No	String		リージョンコード修正するAuto Scaling Groupのリージョン(Region)を決定できます。 regionCodeはgetRegionListアクションを通じて取得できます。 Default：getRegionList照会結果の最初のリージョンを選択
autoScalingGroupNo	Yes	String		修正するAuto Scaling Group番号 autoScalingGroupNoはgetAutoScalingGroupListアクションを通じて取得できます。
launchConfigurationNo	No	String		Launch Configuration番号 Scale-outで作成されるサーバ関連情報を持つLaunch Configurationを変更できます。 launchConfigurationNoはgetLaunchConfigurationListアクションを通じて取得できます。
serverNamePrefix	No	String	Min : 3, Max : 7 小文字、数字、特殊文字のハイフン「-」のみが認められ、最初の文字をアルファベットにしてください。アルファベットまたは数字で終わるようにしてください。	Scale-outによって作成されるサーバ名のPrefixを変更できます。サーバ名のルールは、[Prefix]-[アルファベット\|数字]で、設定したPrefixを除いた残りはランダムなアルファベット、数字で自動作成されます。
minSize	Yes	Integer	Min : 0, Max : 30	最小容量 Auto Scaling Groupの最小サーバ数を変更できます。常にこの値以上のサーバ数が維持されます。サーバを1台も保有しないことを可能にするためには、0に設定します。 maxSize以下でなければなりません。
maxSize	Yes	Integer	Min : 0, Max : 30	最大容量 Auto Scaling Groupで作成できる最大サーバ数を変更できます。 minSize以上でなければなりません。
desiredCapacity	No	Integer	Min : 0, Max : 30	希望する容量希望する容量に応じてサーバ数が調整されます。変更しようとする希望する容量は、minSize以上でなおかつmaxSize以下でなければなりません。
defaultCoolDown	No	Integer	Min : 0, Max : 2147483647	クールダウンのデフォルト値新しいサーバが作成されたとしても、初期化スクリプトの実行やアップデートのインストールなどの理由で実際のサービスを実行できるように準備が整うまでは時間がかかる場合があります。クールダウン(Cooldown)時間とは、実際にScalingが実行中か、実行完了した後にモニタリングイベントアラームが発生しても反応せず無視させる設定をした期間です。
healthCheckGracePeriod	Conditional	Integer	Min : 0, Max : 2147483647	ヘルスチェックの猶予期間サーバインスタンスが作成されて「運用中」に変わったとしても、サーバアップデートのインストールなどの作業により、ヘルスチェックに正常に応答できない場合があります。こういった場合、ヘルスチェック猶予期間を指定すると、当該期間中にヘルスチェックに失敗してもサーバヘルスに異常があるとは判断しません。 healthCheckTypeCodeをLOADBに変更する場合、必ず入力します。
healthCheckTypeCode	No	String		ヘルスチェックタイプのコードヘルスチェックタイプを変更できます。 LOADBである場合、必ずhealthCheckGracePeriodを入力しなければなりません。 Options : SVR (Server) \| LOADB (Load Balancer)
responseFormatType	No	String		レスポンス結果のフォーマットタイプ Options : xml \| json Default : xml

レスポンス

レスポンスデータのタイプ

AutoScalingGroupListタイプ

AutoScalingGroupList extends CommonResponse
private Integer totalRows;
private List autoScalingGroup = new ArrayList<>();

AutoScalingGroup
private String vpcNo;
private String subnetNo;
private String serverNamePrefix;
private String autoScalingGroupNo;
private String autoScalingGroupName;
private String launchConfigurationNo;
private Integer minSize;
private Integer maxSize;
private Integer desiredCapacity;
private Integer defaultCoolDown;
private Integer healthCheckGracePeriod;
private CommonCode healthCheckType;
private Date createDate;
private CommonCode autoScalingGroupStatus;
private TargetGroupNoList targetGroupNoList;
private List inAutoScalingGroupServerInstanceList;
private AccessControlGroupNoList accessControlGroupNoList;
private List suspendedProcessList;

TargetGroupNoList
private List targetGroupNoList = new ArrayList<>();

InAutoScalingGroupServerInstance
private String serverInstanceNo;
private CommonCode healthStatus;
private CommonCode lifecycleState;

AccessControlGroupNoList
private List accessControlGroupNoList = new ArrayList<>();

SuspendedProcess
private CommonCode process;
private String suspensionReason;

例

リクエスト例

ncloud vautoscaling updateAutoScalingGroup --regionCode KR --autoScalingGroupNo ***700 --launchConfigurationNo ***163 --serverNamePrefix test --minSize 0 --maxSize 0 --desiredCapacity 0 --defaultCoolDown 300 --healthCheckGracePeriod 300 --healthCheckTypeCode SVR

レスポンス例

<updateAutoScalingGroupResponse>
  <requestId></requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <autoScalingGroupList>
    <autoScalingGroup>
      <vpcNo>***04</vpcNo>
      <subnetNo>***43</subnetNo>
      <serverNamePrefix></serverNamePrefix>
      <autoScalingGroupNo>***700</autoScalingGroupNo>
      <autoScalingGroupName>test-***</autoScalingGroupName>
      <launchConfigurationNo>***163</launchConfigurationNo>
      <minSize>0</minSize>
      <maxSize>0</maxSize>
      <desiredCapacity>0</desiredCapacity>
      <defaultCoolDown>300</defaultCoolDown>
      <healthCheckGracePeriod>300</healthCheckGracePeriod>
      <healthCheckType>
        <code>SVR</code>
        <codeName>Server</codeName>
      </healthCheckType>
      <createDate>2020-12-07T13:10:30+0900</createDate>
      <autoScalingGroupStatus>
        <code>CREAT</code>
        <codeName>Created</codeName>
      </autoScalingGroupStatus>
      <targetGroupNoList/>
      <inAutoScalingGroupServerInstanceList/>
      <accessControlGroupNoList>
        <accessControlGroupNo>***63</accessControlGroupNo>
      </accessControlGroupNoList>
      <suspendedProcessList/>
    </autoScalingGroup>
  </autoScalingGroupList>
</updateAutoScalingGroupResponse>