createAutoScalingGroup

VPC環境で利用できます。

概要

Auto Scaling Groupを作成します。

リクエスト

リクエストパラメータ

パラメータ名	必須有無	タイプ	制約事項	説明
regionCode	No	String		リージョンコード Auto Scaling Groupが作成されるリージョン(Region)を決定できます。 regionCodeはgetRegionListアクションを通じて取得できます。 Default：getRegionList照会結果の最初のリージョンを選択
launchConfigurationNo	Yes	String		Launch Configuration番号 Scale-outで作成されるサーバ関連情報を持つLaunch Configurationを決定します。 launchConfigurationNoはgetLaunchConfigurationListアクションを通じて取得できます。
autoScalingGroupName	No	String	Min : 1, Max : 255 小文字、数字、特殊文字のハイフン「-」のみが認められ、最初の文字をアルファベットにしてください。アルファベットまたは数字で終わるようにしてください。	Auto Scaling Group名 Default：NAVERクラウドプラットフォームが自動的に付与します。
vpcNo	Yes	String		VPC番号 Auto Scalingが実行されるVPCを決定します。 vpcNoはgetVpcListアクションを通じて取得できます。
subnetNo	Yes	String		Subnet番号 Auto Scalingが実行されるSubnetを決定します。 subnetNoはgetSubnetListアクションを通じて取得できます。
accessControlGroupNoList.N	Yes	List<String>	Min：1、Max：3個	Scale-outによって作成されるサーバグループに適用されるACG番号リスト最大3個のACGを適用できます。 accessControlGroupNoはgetAccessControlGroupListアクションを通じて取得できます。 ex) accessControlGroupNoList.1=1234&accessControlGroupNoList.2=2345
serverNamePrefix	No	String	Min : 3, Max : 7 小文字、数字、特殊文字のハイフン「-」のみが認められ、最初の文字をアルファベットにしてください。アルファベットまたは数字で終わるようにしてください。	Scale-outによって作成されるサーバ名のPrefix サーバ名のルールは、[Prefix]-[アルファベット\|数字]で、設定したPrefixを除いた残りはランダムなアルファベット、数字で自動作成されます。 Default : s
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以下でなければなりません。 Default：minSizeと同じ値
defaultCoolDown	No	Integer	Min : 0, Max : 2147483647	クールダウンのデフォルト値新しいサーバが作成されたとしても、初期化スクリプトの実行やアップデートのインストールなどの理由で実際のサービスを実行できるように準備が整うまでは時間がかかる場合があります。クールダウン(Cooldown)時間とは、実際にScalingが実行中か、実行完了した後にモニタリングイベントアラームが発生しても反応せず無視させる設定をした期間です。 Default：300秒
healthCheckGracePeriod	Conditional	Integer	Min : 0, Max : 2147483647	ヘルスチェックの猶予期間サーバインスタンスが作成されて「運用中」に変わったとしても、サーバアップデートのインストールなどの作業により、ヘルスチェックに正常に応答できない場合があります。こういった場合、ヘルスチェック猶予期間を指定すると、当該期間中にヘルスチェックに失敗してもサーバヘルスに異常があるとは判断しません。 healthCheckTypeCodeがLOADBである場合、必ず入力します。 Default：300秒
healthCheckTypeCode	No	String		ヘルスチェックタイプのコードヘルスチェックタイプを決定できます。 LOADBである場合はhealthCheckGracePeriodの値を必ず入力しなければならず、ターゲットグループリストを指定することができ、各ターゲットグループのヘルスチェック方式と基準に基づいてサーバの状態を判断します。 Options : SVR (Server) \| LOADB (Load Balancer) Default : SVR
targetGroupNoList.N	No	List<String>		ターゲットグループ番号リスト healthCheckTypeCodeがLOADBである場合にのみ有効であり、各ターゲットグループのヘルスチェック方式と基準に基づいてサーバの状態を判断できます。 targetGroupNoはgetTargetGroupListアクションを通じて取得できます。 ex) targetGroupNoList.1=1234&targetGroupNoList.2=2345
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 createAutoScalingGroup --regionCode KR --launchConfigurationNo ***163 --autoScalingGroupName test-*** --vpcNo ***04 --subnetNo ***43 --accessControlGroupNoList ***63 --serverNamePrefix test --minSize 0 --maxSize 0 --desiredCapacity 0 --defaultCoolDown 300 --healthCheckGracePeriod 300 --healthCheckTypeCode SVR

レスポンス例

<createAutoScalingGroupResponse>
  <requestId></requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <autoScalingGroupList>
    <autoScalingGroup>
      <vpcNo>***04</vpcNo>
      <subnetNo>***43</subnetNo>
      <serverNamePrefix>test</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>
</createAutoScalingGroupResponse>