createAutoScalingGroup

Prev Next

概要

オートスケーリンググループの作成

説明

識別子の役割をする名称とその他の属性を指定して新しいオートスケーリンググループを作成します。
作成リクエストが完了されると、オートスケーリンググループは他の呼び出しで使える、完成された状態になります。
但し、作成リクエストが完了されたとしても、グループ所属のサーバインスタンスの作成が完了され、サービスへの投入が完了されたのを保証することではありません。

リクエストパラメータ

パラメータ名 必須 タイプ 制約事項 説明
autoScalingGroupName No String Min : 1, Max : 255 オートスケーリンググループ名はグループ識別子の役割をします。一度決まったら変更できません。
launchConfigurationName Yes String Min : 1, Max : 255 ローンチ設定名です。
該当するオートスケーリンググループ所属のサーバインスタンスが新しく作成される時に使うサーバ関連情報をもっています。
desiredCapacity No Integer Min : 0, Max : 30 期待サービスのキャパシティであり、該当するグループ所属で運用されるサーバインスタンスの数を設定します。
この値はオートスケーリングに、すでに設定されている既存属性であるmin sizeより大きく、max sizeより小さく設定する必要があります。
minSize Yes Integer Min : 0, Max : 30 最小サイズ(最小0で、maxSizeの値より小さいか同じ)です。
Min : 最小サイズ(minSize)、Max : 最大サイズ(maxSize)
Min : 0、Max : 30
maxSize Yes Integer Min : 0, Max : 30 最大サイズ(最小0、最大30)です。
defaultCooldown No Integer Min : 0, Max : 2147483647 デフォルトcooldown時間です。
Default : 300秒に設定
loadBalancerNameList No List Min : 3, Max : 30(重複不可) 該当するグループ所属のサーバが作成され、サービスに投入される時に登録されるロードバランサー名のリストです。
healthCheckGracePeriod Conditional Integer Min : 0, Max : 2147483647 health checkの保留期間中、サーバインスタンスが サービスに投入された以降、health checkを保留する時間を設定します。
healthCheckTypeCode値がロードバランサー(LOADB)である場合は必須です。
healthCheckTypeCode No String Min : 1, Max : 5 Health checkタイプコードです。
現在使えるタイプ(type)コードには、サーバ(SVR)とロードバランサー(LOADB)があります。
zoneNoList Yes String 重複不可 Zone番号のリストです。
このグループ所属のサーバインスタンスが存在するzone番号リストを入れます
例示) zone code: 2 , zone name: KR-1/ zone code: 3 , zone name: KR-2

レスポンスデータタイプ

  • AutoScalingGroupListタイプ
AutoScalingGroupList extends CommonResponse
private Integer totalRows;
private List autoScalingGroupList = new ArrayList();
AutoScalingGroup extends BaseObject
private String autoScalingGroupName;
private String launchConfigurationName;
private Integer desiredCapacity;
private Integer minSize;
private Integer maxSize;
private Integer defaultCooldown;
private List loadBalancerInstanceSummaryList;
private Integer healthCheckGracePeriod;
private CommonCode healthCheckType;
private Date createDate;
private List inAutoScalingGroupServerInstanceList;
private List suspendedProcessList;
private List zoneList;
LoadBalancerInstanceSummary extends BaseObject
private String loadBalancerInstanceNo;
private String loadBalancerName;
InAutoScalingGroupServerInstance extends BaseObject
private CommonCode healthStatus;
private CommonCode lifecycleState;
private LaunchConfiguration launchConfiguration;
private String serverInstanceNo;
private String serverInstanceName;
SuspendedProcess
private CommonCode process;
private String suspensionReason;
Zone
private String zoneNo;
private String zoneName;
private String zoneCode;
private String zoneDescription;
private String regionNo;
private long totalMemorySize;
private long totalUsedMemorySize;
private long totalUsePossibleMemorySize;
CommonCode
private String codeKind;
private String detailCategorizeCode;
private String code;
private String codeName;
private Integer codeOrder;
private String javaConstantCode;
LaunchConfiguration
private String launchConfigurationName;
private String serverImageProductCode;
private String serverProductCode;
private String memberServerImageNo;
private String loginKeyName;
private Date createDate;
private String userData;
private List accessControlGroupList;
AccessControlGroup extends BaseObject
private String accessControlGroupConfigurationNo;
private String accessControlGroupName;
private String accessControlGroupDescription;
private boolean isDefault;
private Date createDate;

例示

呼び出し

ncloud autoscaling createAutoScalingGroup --autoScalingGroupName test-autoscaling-group --launchConfigurationName test-autoscailg-launch --minSize 0 --maxSize 1 --zoneNoList 2

レスポンス

{
  "createAutoScalingGroupResponse": {
    "requestId": "08c6d98c-1b6e-4c52-9099-4d32555b34aa",
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": 1,
    "autoScalingGroupList": [
      {
        "autoScalingGroupName": "test-autoscaling-group",
        "launchConfigurationName": "test-autoscailg-launch",
        "desiredCapacity": 0,
        "minSize": 0,
        "maxSize": 1,
        "defaultCooldown": 300,
        "loadBalancerInstanceSummaryList": [],
        "healthCheckGracePeriod": 300,
        "healthCheckType": {
          "code": "SVR",
          "codeName": "Server"
        },
        "createDate": "2018-04-05T20:43:57+0900",
        "inAutoScalingGroupServerInstanceList": [],
        "suspendedProcessList": [],
        "zoneList": [
          {
            "zoneNo": "2",
            "zoneName": "KR-1",
            "zoneCode": "KR-1",
            "zoneDescription": "KR-1 zone",
            "regionNo" : "1"
          }
        ]
      }
    ]
  }
}
<?xml version="1.0" encoding="UTF-8" ?>
<createAutoScalingGroupResponse>
  <requestId>08c6d98c-1b6e-4c52-9099-4d32555b34aa</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <autoScalingGroupList>
    <autoScalingGroupName>test-autoscaling-group</autoScalingGroupName>
    <launchConfigurationName>test-autoscailg-launch</launchConfigurationName>
    <desiredCapacity>0</desiredCapacity>
    <minSize>0</minSize>
    <maxSize>1</maxSize>
    <defaultCooldown>300</defaultCooldown>
    <loadBalancerInstanceSummaryList/>
    <healthCheckGracePeriod>300</healthCheckGracePeriod>
    <healthCheckType>
      <code>SVR</code>
      <codeName>Server</codeName>
    </healthCheckType>
    <createDate>2018-04-05T20:43:57+0900</createDate>
    <inAutoScalingGroupServerInstanceList/>
    <suspendedProcessList/>
    <zoneList>
      <zoneNo>2</zoneNo>
      <zoneName>KR-1</zoneName>
      <zoneCode>KR-1</zoneCode>
      <zoneDescription>KR-1 zone</zoneDescription>
      <regionNo>1</regionNo>
    </zoneList>
  </autoScalingGroupList>
</createAutoScalingGroupResponse>