ビジネスの変化やポリシーに基づいて計算容量(インスタンス数)を自動的に調整するためのスケーリンググループを作成します。
操作説明
スケーリンググループは、同じ適用シナリオに対応する ECS インスタンスのコレクションです。
リージョン内で作成できるスケーリンググループの数は、Auto Scaling の
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ess:CreateScalingGroup |
create |
*ScalingGroup。
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ScalingGroupName |
string |
任意 |
スケーリンググループの名前。名前はリージョン内で一意である必要があります。 名前は 2~64 文字で、英数字、アンダースコア (_)、ハイフン (-)、ピリオド (.) を含めることができます。先頭は数字、英字、または漢字である必要があります。 デフォルト値:ScalingGroupId の値。 |
scalinggroup**** |
| LaunchTemplateId |
string |
任意 |
スケーリンググループが起動構成情報を取得する起動テンプレートの ID。 |
lt-m5e3ofjr1zn1aw7**** |
| LaunchTemplateVersion |
string |
任意 |
起動テンプレートのバージョン。有効な値:
|
Default |
| InstanceId |
string |
任意 |
インスタンスの ID。スケーリンググループの作成時、指定されたインスタンスから必須の構成情報が取得され、スケーリング設定が自動作成の対象となります。 |
i-28wt4**** |
| RegionId |
string |
必須 |
スケーリンググループのリージョン ID。 |
cn-qingdao |
| MinSize |
integer |
必須 |
スケーリンググループ内のインスタンスの最小値。スケーリンググループ内のインスタンス数が MinSize 値未満の場合、Auto Scaling はインスタンスの自動作成を実行します。 説明
MinSize の値は MaxSize の値以下である必要があります。 |
2 |
| MaxSize |
integer |
必須 |
スケーリンググループ内のインスタンスの最大値。スケーリンググループ内のインスタンス数が MaxSize 値を超えた場合、Auto Scaling は自動的にインスタンスを削除します。 MaxSize の有効な値は、Auto Scaling の使用量によって異なります。単一スケーリンググループ内のインスタンスの最大値のクォータを確認するには、クォータセンター に移動してください。 単一スケーリンググループ内のインスタンスの最大値のクォータが 2000 の場合、MaxSize の有効な値は 0~2000 です。 |
20 |
| DefaultCooldown |
integer |
任意 |
スケーリングアクティビティ(インスタンスの追加または削除)完了後のクールダウン時間。有効な値:0~86400。単位:秒。 クールダウン時間中、スケーリンググループは他のスケーリングアクティビティを実行しません。これは CloudMonitor のイベントトリガータスクによってトリガーされたスケーリングアクティビティにのみ適用されます。 デフォルト値:300。 |
300 |
| LoadBalancerIds |
string |
任意 |
CLB インスタンスの ID。値は複数の CLB インスタンス ID で構成される JSON 配列にすることができます。複数の ID はコンマ (,) で区切ります。 単一スケーリンググループに関連付けられる CLB インスタンスの総数は、Auto Scaling の使用量によって異なります。単一スケーリンググループに関連付けられる負荷分散インスタンスの総数のクォータを確認するには、クォータセンター に移動してください。 |
["lb-bp1u7etiogg38yvwz****", "lb-bp168cqrux9ai9l7f****", "lb-bp1jv3m9zvj22ufxp****"] |
| DBInstanceIds |
string |
任意 |
ApsaraDB RDS インスタンスの ID。値は複数の RDS インスタンス ID で構成される JSON 配列にすることができます。複数の ID はコンマ (,) で区切ります。 単一スケーリンググループに関連付けられる RDS インスタンスの総数は、Auto Scaling の使用量によって異なります。単一スケーリンググループに関連付けられる RDS インスタンスの総数のクォータを確認するには、クォータセンター に移動してください。 |
["rm-bp142f86de0t7****", "rm-bp18l1z42ar4o****", "rm-bp1lqr97h4aqk****"] |
| RemovalPolicies |
array |
任意 |
スケールインポリシーのフィルターポリシー。有効な値:
OldestScalingConfiguration で言及されるスケーリング設定とは、スケーリンググループ内のインスタンス構成ソース(スケーリング設定や起動テンプレートを含む)を指します。CustomPolicy は最初のスケールインポリシーとしてのみセットできます。CustomPolicy を指定する場合は、CustomPolicyARN パラメーターも指定する必要があります。 説明
スケーリンググループからの ECS インスタンスの削除は、スケーリンググループのスケーリングポリシー(MultiAZPolicy)の影響も受けます。詳細については、「インスタンス削除のための組み合わせポリシーの設定」をご参照ください。 |
|
|
string |
任意 |
スケールインポリシーのフィルターポリシー。有効な値:
OldestScalingConfiguration で言及されるスケーリング設定とは、スケーリンググループ内のインスタンス構成ソース(スケーリング設定や起動テンプレートを含む)を指します。CustomPolicy は最初のスケールインポリシーとしてのみセットできます。CustomPolicy を指定する場合は、CustomPolicyARN パラメーターも指定する必要があります。 説明
スケーリンググループからの ECS インスタンスの削除は、スケーリンググループのスケーリングポリシー(MultiAZPolicy)の影響も受けます。詳細については、「インスタンス削除のための組み合わせポリシーの設定」をご参照ください。 |
OldestScalingConfiguration |
|
| VSwitchId |
string |
任意 |
vSwitch の ID。このパラメーターを指定すると、スケーリンググループのネットワークタイプは VPC になります。 説明
VSwitchId と VSwitchIds のどちらも指定しない場合、スケーリンググループのネットワークタイプはデフォルトでクラシックネットワークになります。 |
vsw-bp14zolna43z266bq**** |
| MultiAZPolicy |
string |
任意 |
マルチゾーンスケーリンググループ内の ECS インスタンスのスケーリングポリシー。有効な値:
デフォルト値:PRIORITY。 |
PRIORITY |
| HealthCheckType |
string |
任意 |
スケーリンググループのヘルスチェックモード。有効な値:
デフォルト値:ECS。 説明
インスタンスのヘルスチェックとロードバランサーのヘルスチェックの両方を有効にするには、 |
ECS |
| ScalingPolicy |
string |
任意 |
スケーリンググループの取り消すモードを指定します。有効な値:
ScalingPolicy はスケーリンググループの取り消すモードを指定しますが、インスタンスがスケーリンググループから削除される際の具体的なアクションは、RemoveInstances の RemovePolicy パラメーターによって決定されます。詳細については、「 RemoveInstances 」をご参照ください。 |
recycle |
| ClientToken |
string |
任意 |
リクエストのべき等性を確保します。 クライアント側で生成するパラメーター値で、異なるリクエスト間で一意である必要があります。値には ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。詳細については、「べき等性の確保方法」をご参照ください。 |
123e4567-e89b-12d3-a456-42665544**** |
| OnDemandBaseCapacity |
integer |
任意 |
スケーリンググループに必要な従量課金インスタンスの最小値。有効な値:0~1000。従量課金インスタンスの数がこの値未満の場合、従量課金インスタンスが優先的に作成されます。 |
30 |
| OnDemandPercentageAboveBaseCapacity |
integer |
任意 |
従量課金インスタンスの最小値(OnDemandBaseCapacity)を満たした後の超過インスタンスのうち、従量課金インスタンスが占める割合。有効な値:0~100。 |
20 |
| SpotInstanceRemedy |
boolean |
任意 |
補充スポットインスタンスポリシーを有効にするかどうかを指定します。このポリシーを有効にすると、Auto Scaling グループがスポットインスタンスの回収予定を示すシステムメッセージを受信した際に、回収予定のスポットインスタンスを置き換える新しいインスタンスの作成を試行します。 |
true |
| CompensateWithOnDemand |
boolean |
任意 |
価格、在庫、またはその他の理由でスポットインスタンスを作成できない場合に、必要な ECS インスタンス数を満たすために従量課金インスタンスを自動的に作成するかどうかを指定します。このパラメーターは MultiAZPolicy が COST_OPTIMIZED に設定されている場合にのみ効果があります。有効な値:
デフォルト値:true。 |
true |
| SpotInstancePools |
integer |
任意 |
利用可能なインスタンスタイプの数。スケーリンググループは、複数のインスタンスタイプにわたって最低コストでバランスよくスポットインスタンスを作成します。有効な値:1~10。 |
5 |
| DesiredCapacity |
integer |
任意 |
スケーリンググループ内の予想インスタンス数。スケーリンググループは、インスタンス数を自動的に予想数に維持します。値は MaxSize より大きくなく、MinSize より小さくない必要があります。 |
5 |
| GroupDeletionProtection |
boolean |
任意 |
スケーリンググループの削除保護を有効にするかどうかを指定します。有効な値:
デフォルト値:false。 |
true |
| GroupType |
string |
任意 |
スケーリンググループが管理するインスタンスのタイプ。有効な値:
デフォルト値:ECS。 |
ECS |
| ContainerGroupId |
string |
任意 |
ECI インスタンスの ID。コンテナグループの ID です。 |
eci-uf6fonnghi50u374**** |
| VSwitchIds |
array |
任意 |
1 つ以上の vSwitch の ID。VSwitchIds を指定すると、VSwitchId パラメーターは無視されます。このパラメーターを指定すると、スケーリンググループのネットワークタイプは VPC になります。 複数の vSwitch を指定する場合:
説明
VSwitchId と VSwitchIds のどちらも指定しない場合、スケーリンググループのネットワークタイプはデフォルトでクラシックネットワークになります。 |
|
|
string |
任意 |
1 つ以上の vSwitch の ID。VSwitchIds を指定すると、VSwitchId パラメーターは無視されます。このパラメーターを指定すると、スケーリンググループのネットワークタイプは VPC になります。 複数の vSwitch を指定する場合:
説明
VSwitchId と VSwitchIds のどちらも指定しない場合、スケーリンググループのネットワークタイプはデフォルトでクラシックネットワークになります。 |
vsw-bp14zolna43z266bq**** |
|
| LifecycleHooks |
array<object> |
任意 |
ライフサイクルフック情報のリスト。 |
|
|
object |
任意 |
ライフサイクルフック情報のリスト。 |
||
| DefaultResult |
string |
任意 |
待機状態終了後の次の操作。有効な値:
スケールインアクティビティ (SCALE_IN) が複数のライフサイクルフックをトリガーした場合、DefaultResult が ABANDON にセットされたライフサイクルフックの待機状態が終了すると、他の対応するライフサイクルフックの待機状態も早期に終了します。それ以外の場合、次の操作は待機状態が最後に終了したライフサイクルフックによって決定されます。 デフォルト値:CONTINUE。 |
CONTINUE |
| LifecycleHookName |
string |
任意 |
ライフサイクルフックの名前。名前を指定した後に変更済みすることはできません。指定しない場合、名前はデフォルトでライフサイクルフック ID になります。 |
lifecyclehook**** |
| LifecycleTransition |
string |
任意 |
ライフサイクルフックが適用されるスケーリングアクティビティのタイプ。有効な値:
説明
スケーリンググループにライフサイクルフックが指定されている場合、このパラメーターは必須です。その他の関連パラメーターはオプションです。 |
SCALE_OUT |
| NotificationMetadata |
string |
任意 |
スケーリングアクティビティの待機状態に関する固定文字列情報。パラメーター値の長さは 4096 文字を超えることはできません。Auto Scaling が通知の受信者にメッセージをプッシュするたびに、事前に指定した notificationmetadata パラメーター値も送信されるため、さまざまなカテゴリの通知情報を管理およびマークするのに役立ちます。このパラメーターは、notificationarn パラメーターも指定されている場合にのみ効果があります。 |
Test |
| NotificationArn |
string |
任意 |
ライフサイクルフックの通知の受信者 ID。以下のタイプの通知オブジェクトがサポートされています:Simple Message Queue(旧 MNS)キューおよび Topic。パラメーター値のフォーマットは acs:ess:{region}:{account-id}:{resource-relative-id} です。
例:
|
acs:ess:cn-hangzhou:1111111111:queue/queue2 |
| HeartbeatTimeout |
integer |
任意 |
ライフサイクルフックによってスケーリンググループアクティビティにセットされる待機時間。待機状態がタイムアウトした後、次の操作が実行されます。有効な値:30~21600。単位:秒。 ライフサイクルフックの作成後、RecordLifecycleActionHeartbeat を呼び出してインスタンスの待機時間を延長するか、CompleteLifecycleAction を呼び出してスケーリングアクティビティの待機状態を早期に終了させることができます。 デフォルト値:600。 |
600 |
| VServerGroups |
array<object> |
任意 |
スケーリンググループに関連付けられた仮想サービスグループの情報。 |
|
|
array<object> |
任意 |
スケーリンググループに関連付けられた仮想サービスグループの情報。 |
||
| VServerGroupAttributes |
array<object> |
任意 |
バックエンドサーバーグループの属性。 |
|
|
object |
任意 |
バックエンドサーバーグループの属性。 |
||
| VServerGroupId |
string |
任意 |
仮想サービスグループの ID。 |
rsp-bp1443g77**** |
| Weight |
integer |
任意 |
Auto Scaling がインスタンスを仮想サービスグループに追加した後の、バックエンドサーバーとしてのインスタンスの重み。重みが大きいほど、より多くのアクセスリクエストがインスタンスに割り当てられます。重みが 0 の場合、インスタンスはアクセスリクエストを受信しません。有効な値:0~100。 デフォルト値:50。 |
100 |
| Port |
integer |
任意 |
Auto Scaling がインスタンスを仮想サービスグループに追加した後にインスタンスが使用するポート番号。有効な値:1~65535。 |
22 |
| LoadBalancerId |
string |
任意 |
仮想サービスグループが属する CLB (Classic Load Balancer) インスタンスの ID。 |
lb-bp1u7etiogg38yvwz**** |
| Tags |
array<object> |
任意 |
スケーリンググループのタグ。 |
|
|
object |
任意 |
スケーリンググループのタグ。 |
||
| Key |
string |
任意 |
スケーリンググループのタグキー。 |
Department |
| Value |
string |
任意 |
スケーリンググループのタグ値。 |
Finance |
| Propagate |
boolean |
任意 |
タグが伝播可能なタグかどうかを指定します。有効な値:
デフォルト値:false。 |
false |
| LaunchTemplateOverrides |
array<object> |
任意 |
起動テンプレートを拡張するインスタンスタイプ情報。 |
|
|
object |
任意 |
起動テンプレートを拡張するインスタンスタイプ情報。 |
||
| InstanceType |
string |
任意 |
スケーリンググループがインスタンスタイプの容量に基づいてスケーリングを行うようにしたい場合は、このパラメーターと LaunchTemplateOverrides.WeightedCapacity の両方を指定します。 このパラメーターはインスタンスタイプを指定し、起動テンプレート内のインスタンスタイプをオーバーライドします。 説明
このパラメーターは、LaunchTemplateId パラメーターが起動テンプレートを指定している場合にのみ効果があります。 InstanceType の有効な値:購入可能な ECS インスタンスタイプ。 |
ecs.c5.xlarge |
| WeightedCapacity |
integer |
任意 |
スケーリンググループがインスタンスタイプの容量に基づいてスケーリングを行うようにしたい場合は、LaunchTemplateOverrides.InstanceType を指定した後にこのパラメーターを指定します。 このパラメーターはインスタンスタイプの重みを指定します。これは、スケーリンググループ内でのこのタイプの単一インスタンスの容量を表します。重みが大きいほど、予想される容量を満たすために必要なこのタイプのインスタンス数は少なくなります。 vCPU 数やメモリサイズなどのパフォーマンスメトリクスはインスタンスタイプによって異なるため、要件に基づいて異なるインスタンスタイプに異なる重みを割り当てることができます。 例:
予想される容量を満たすために、スケーリンググループは 2 つの ecs.c5.xlarge インスタンスをスケールアウトします。 説明
スケールアウト時、スケーリンググループの容量は、最大容量 (MaxSize) とインスタンスタイプの最大値の合計を超えてはなりません。 WeightedCapacity の有効な値:1~500。 |
4 |
| SpotPriceLimit |
number |
任意 |
起動テンプレートオーバーライド ( 説明
このパラメーターは、 |
0.025 |
| AlbServerGroups |
array<object> |
任意 |
ALB サーバーグループの情報。 |
|
|
object |
任意 |
ALB サーバーグループの情報。 |
||
| AlbServerGroupId |
string |
任意 |
ALB サーバーグループの ID。 スケーリンググループに関連付けられる ALB サーバーグループの数には制限があります。クォータの確認または引き上げのリクエストを行うには、クォータセンター に移動してください。 |
sgp-ddwb0y0g6y9bjm**** |
| Weight |
integer |
任意 |
Auto Scaling がインスタンスを ALB サーバーグループに追加した後の、バックエンドサーバーとしてのインスタンスの重み。重みが大きいほど、より多くのアクセスリクエストがインスタンスに分散されます。重みが 0 の場合、インスタンスはアクセスリクエストを受信しません。有効な値:0~100。 |
100 |
| Port |
integer |
任意 |
Auto Scaling がインスタンスを ALB サーバーグループに追加した後にインスタンスが使用するポート番号。有効な値:1~65535。 |
22 |
| ServerGroups |
array<object> |
任意 |
ロードバランサーサーバーグループの情報。 説明
AlbServerGroups と ServerGroups の両方に同じサーバーグループ情報を指定することはできません。 |
|
|
object |
任意 |
ロードバランサーサーバーグループの情報。 |
||
| ServerGroupId |
string |
任意 |
サーバーグループ ID。 |
sgp-5yc3bd9lfyh***** |
| Type |
string |
任意 |
サーバーグループのタイプ。有効な値:
|
ALB |
| Weight |
integer |
任意 |
Auto Scaling がインスタンスをサーバーグループに追加した後の、バックエンドサーバーとしてのインスタンスの重み。有効な値:0~100。 重みが大きいほど、より多くのアクセスリクエストがインスタンスに割り当てられます。重みが 0 の場合、インスタンスはアクセスリクエストを受信しません。 説明
このパラメーターは ALB および NLB タイプのロードバランサーサーバーグループで必須です。GWLB タイプのロードバランサーサーバーグループではセットできません。 |
100 |
| Port |
integer |
任意 |
Auto Scaling がインスタンスをサーバーグループに追加した後にインスタンスが使用するポート番号。有効な値:1~65535。 |
22 |
| AzBalance |
boolean |
任意 |
スケーリンググループの容量が複数のゾーンに均等に分散されるかどうかを指定します。このパラメーターは
説明
デフォルト値:false。 |
false |
| AllocationStrategy |
string |
任意 |
容量要件を満たすためにスケーリンググループが利用可能なインスタンスタイプを選択する方法を決定する容量割り当て戦略。容量割り当て戦略は、従量課金容量とスポット容量の両方に適用されます。このパラメーターは
デフォルト値:priority。 |
priority |
| SpotAllocationStrategy |
string |
任意 |
スポット容量の割り当て戦略。このパラメーターを使用して、スポット容量の割り当て戦略を個別に指定できます。このパラメーターは
デフォルト値:priority。 |
lowestPrice |
| SyncAlarmRuleToCms |
boolean |
任意 |
説明
このパラメーターは使用できません。 |
false |
| MaxInstanceLifetime |
integer |
任意 |
インスタンスがスケーリンググループ内に存在できる最大時間。単位:秒。 有効な値:[86400, Integer.maxValue]。 デフォルト値:null。 |
null |
| CustomPolicyARN |
string |
任意 |
カスタムスケールインポリシー(関数)の Amazon リソースネーム (ARN)。このパラメーターは、RemovalPolicies の最初のスケールインポリシーが CustomPolicy に設定されている場合にのみ効果があります。 |
acs:fc:cn-zhangjiakou:16145688****:services/ess_custom_terminate_policy.LATEST/functions/ess_custom_terminate_policy_name |
| ResourceGroupId |
string |
任意 |
新しく作成されたスケーリンググループが属するリソースグループの ID。 説明
新しく作成されたスケーリンググループは、指定されたリソースグループに追加されます。このパラメーターを指定しない場合、スケーリンググループはデフォルトのリソースグループに追加されます。 |
rg-123****** |
| LoadBalancerConfigs |
array<object> |
任意 |
ロードバランサー構成のリスト。 |
|
|
object |
任意 |
ロードバランサー CLB(旧 SLB)構成のリスト。 |
||
| LoadBalancerId |
string |
任意 |
ロードバランサー CLB(旧 SLB)インスタンスの ID。 |
lb-2zen1olhfg9yw3f4q**** |
| Weight |
integer |
任意 |
Auto Scaling がインスタンスを SLB サーバーグループに追加した後の、バックエンドサーバーとしてのインスタンスの重み。重みが大きいほど、より多くのアクセスリクエストがインスタンスに分散されます。重みが 0 の場合、インスタンスはアクセスリクエストを受信しません。有効な値:0~100。 |
10 |
| HealthCheckTypes |
array |
任意 |
スケーリンググループのヘルスチェックモード。 説明
このパラメーターを使用して複数の値を設定し、複数のヘルスチェックオプションを有効にできます。 |
|
|
string |
任意 |
スケーリンググループのヘルスチェックモードのリスト。有効な値:
デフォルト値:ECS。 [_ |
ECS |
|
| DBInstances |
array<object> |
任意 |
スケーリンググループに関連付けられたデータベースのリスト。 |
|
|
object |
任意 |
スケーリンググループに関連付けられたデータベースの構成情報。 |
||
| DBInstanceId |
string |
任意 |
データベースインスタンス ID。 |
rm-m5eqju85s45mu0*** |
| Type |
string |
任意 |
データベースタイプ。有効な値:
デフォルト値:RDS。 |
RDS |
| AttachMode |
string |
任意 |
スケーリンググループとデータベースの関連付けモード。有効な値:
|
SecurityIp |
| StopInstanceTimeout |
integer |
任意 |
スケールインプロセス中に ECS インスタンスが停止するのを待機するタイムアウト時間。単位:秒。 有効な値:30~240。 説明
|
60 |
| CapacityOptions |
object |
任意 |
容量オプション。 |
|
| OnDemandBaseCapacity |
integer |
任意 |
既存のスケーリンググループに必要な従量課金インスタンスの最小値。従量課金インスタンスの数がこの値未満の場合、従量課金インスタンスが優先的に作成されます。有効な値:0~1000。
|
30 |
| OnDemandPercentageAboveBaseCapacity |
integer |
任意 |
従量課金インスタンスの最小値(
|
20 |
| CompensateWithOnDemand |
boolean |
任意 |
デフォルト値:true。 |
true |
| SpotAutoReplaceOnDemand |
boolean |
任意 |
デフォルト値:false。 |
false |
| PriceComparisonMode |
string |
任意 |
スケーリンググループのコスト最適化ポリシーにおける価格比較モード。有効な値:
デフォルト値:PricePerUnit。 |
PricePerUnit |
| BalanceMode |
string |
任意 |
ゾーンバランシングモード。このパラメーターはゾーンバランシングが有効な場合にのみ効果があります。有効な値:
デフォルト値:BalancedBestEffort。 |
BalancedBestEffort |
| AutoRebalance |
boolean |
任意 |
スケーリンググループの自動リバランスを有効にするかどうかを指定します。このパラメーターは、ゾーンバランシングされたスケーリンググループで BalancedOnly が有効な場合にのみ効果があります。有効な値:
デフォルト値:false。 |
false |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエスト ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
| ScalingGroupId |
string |
スケーリンググループの ID。 |
asg-bp14wlu85wrpchm0**** |
例
成功レスポンス
JSONJSON
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"ScalingGroupId": "asg-bp14wlu85wrpchm0****"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 404 | ResourceNotAvailable.VPCNetwork | The specified zone does not support vpc network or sold out. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。