ScaleWithAdjustment - Auto Scaling - Alibaba Cloud ドキュメントセンター

ExecuteScalingRule API とは異なり、 ScaleWithAdjustment API を使用すると、事前にスケーリングルールを作成せずに、指定された調整ルールに基づいて弾力的スケーリングをトリガーできます。

操作説明

この操作を呼び出す前に、次の条件が満たされていることを確認してください。
- スケーリンググループがアクティブな状態であること。
- スケーリンググループで実行中のスケーリングアクティビティがないこと。
この操作は、他に実行中のスケーリングアクティビティがない場合、クールダウンをバイパスしてスケーリングアクティビティを即座に実行します。
指定された ECS インスタンスを追加すると総キャパシティが最大サイズを超える場合、Auto Scaling は総キャパシティを最大サイズに設定します。
指定された ECS インスタンスを削除すると総キャパシティが最小サイズを下回る場合、Auto Scaling は総キャパシティを最小サイズに設定します。

正常な応答は、API リクエストが受理されたことを示しますが、スケーリングアクティビティが成功することを保証するものではありません。返された ScalingActivityId を使用して、スケーリングアクティビティのステータスを確認する必要があります。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ess:ScaleWithAdjustment

update

*ScalingGroup

acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ScalingGroupId	string	必須	スケーリンググループの ID です。	asg-j6c1o397427hyjdc****
AdjustmentType	string	必須	スケーリングアクティビティでインスタンス数を調整する方法です。有効な値： `QuantityChangeInCapacity`：指定した数の ECS インスタンスを追加または削除します。 `PercentChangeInCapacity`：指定した割合の ECS インスタンスを追加または削除します。 `TotalCapacity`：スケーリンググループ内の ECS インスタンス数を指定した数に調整します。	QuantityChangeInCapacity
AdjustmentValue	integer	必須	スケーリングアクティビティの調整値です。1 回の調整で追加または削除できる ECS インスタンス数は 1,000 を超えることはできません。有効な範囲は `AdjustmentType` によって異なります： `QuantityChangeInCapacity`：-1000～1000。 `PercentChangeInCapacity`：-100～10000。 `TotalCapacity`：0～2000。	100
MinAdjustmentMagnitude	integer	任意	スケーリングアクティビティで調整するインスタンス数の最小値です。このパラメーターは、`AdjustmentType` を `PercentChangeInCapacity` に設定した場合にのみ有効です。	1
ClientToken	string	任意	リクエストのべき等性を確保するためのクライアント生成トークンです。このトークンは、最大 64 文字の ASCII 文字で構成される一意の文字列である必要があります。	123e4567-e89b-12d3-a456-42665544****
SyncActivity	boolean	任意	スケーリングアクティビティを同期的に実行するかどうかを指定します。このパラメーターは、期待インスタンス数が設定されているスケーリンググループにのみ適用されます。有効な値： `true`：同期実行。スケーリングアクティビティが直ちにトリガーされます。 `false`：非同期実行。呼び出しでは、スケーリングアクティビティを直ちにトリガーせずに、期待インスタンス数を更新します。システムが新しい期待インスタンス数と現在のインスタンス数の差分を検出すると、アクティビティが発生します。説明期待インスタンス数の詳細については、「期待インスタンス数」をご参照ください。デフォルト値：false。	false
ParallelTask	boolean	任意	現在のスケーリングアクティビティが同時実行をサポートするかどうかを指定します。	false
Overrides	object	任意	ECI スケーリンググループのスケールアウト時にオーバーライドするパラメーターです。
Cpu	number	任意	インスタンスの vCPU 数です。単位：コア。	2
Memory	number	任意	インスタンスのメモリサイズです。単位：GiB。	4
ContainerOverrides	array<object>	任意	コンテナごとのオーバーライドのリストです。
	array<object>	任意	単一コンテナのオーバーライドを指定します。
Name	string	任意	オーバーライドするコンテナ名です。この名前がスケーリング設定内のコンテナ名と一致する場合にのみ、オーバーライドが有効になります。	container-1
Args	array	任意	コンテナの起動コマンドの引数です。最大 10 個の引数を指定できます。
	string	任意	起動コマンドの単一の引数です。	arg
Commands	array	任意	文字列の配列として指定するコンテナの起動コマンドです。最大 20 個の文字列を指定でき、各文字列の長さは最大 256 文字です。
	string	任意	コマンド配列内の単一の文字列です。	sleep
EnvironmentVars	array<object>	任意	コンテナに設定する環境変数です。
	object	任意	キーと値のペアとして指定する単一の環境変数です。
Key	string	任意	環境変数名です。長さは 1～128 文字である必要があります。先頭文字に数字は使用できません。また、使用できる文字は英字 (a-z、A-Z)、数字 (0-9)、アンダースコア (_) のみです。	PATH
Value	string	任意	環境変数の値です。最大 256 文字です。	/usr/local/tomcat
Cpu	number	任意	コンテナの vCPU 数です。単位：コア。	2
Memory	number	任意	コンテナのメモリサイズです。単位：GiB。	4
UserData	string	任意	ECS インスタンスのユーザーデータです。Base64 エンコードされた形式である必要があり、未加工データは 32 KB を超えることはできません。	ZWNobyBoZWxsbyBlY3Mh
LifecycleHookContext	object	任意	ライフサイクルフックコンテキストです。
DisableLifecycleHook	boolean	任意	スケーリングアクティビティに対してすべてのライフサイクルフックを無効にするかどうかを指定します。有効な値： `true`：すべてのライフサイクルフックを無効にします。 `false`：ライフサイクルフックを無効にしません。	false
IgnoredLifecycleHookIds	array	任意	スケーリングアクティビティ中に無視するライフサイクルフック ID のリストです。
	string	任意	無視するライフサイクルフックの ID です。	ash-bp14zolna43z266bq***
LifecycleHookResult	string	任意
ActivityMetadata	string	任意	スケーリングアクティビティのメタデータです。	{"key":"value"}
ExecutionMode	string	任意	実行モードです。有効な値： `None`：標準のスケーリングアクティビティを実行します。 `PlanOnly`：スケーリングアクティビティをトリガーせずにエラスティックプランニングのみを実行し、結果を `PlanResult` で返します。結果には、インスタンスタイプ、アベイラビリティーゾーン、課金方法、新規インスタンス数などの詳細が含まれます。デフォルト値：None。	PlanOnly

レスポンスフィールド

フィールド	型	説明	例
	object
ScalingActivityId	string	スケーリングアクティビティの ID です。	asa-bp175o6f6ego3r2j****
RequestId	string	リクエスト ID です。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
ActivityType	string	スケーリングアクティビティのタイプです。このパラメーターが `CapacityChange` に設定されている場合、スケーリングアクティビティはインスタンスを直ちに追加または削除することなく、スケーリンググループの希望する容量のみを調整します。この設定は、希望する容量が設定されているスケーリンググループにのみ影響します。	CapacityChange
PlanResult	object	ExecutionMode が PlanOnly に設定されている場合に返されるスケーリングプランの結果です。
ResourceAllocations	array<object>	スケーリングプランの結果におけるリソース割り当ての詳細です。
	object
ZoneId	string	アベイラビリティーゾーンの ID です。	cn-beijing-g
InstanceType	string	インスタンスタイプです。	ecs.u1-c1m8.large
SpotStrategy	string	インスタンスのスポット戦略です。有効な値は次のとおりです： NoSpot：従量課金インスタンス SpotWithPriceLimit：ユーザー指定の価格上限があるスポットインスタンス SpotAsPriceGo：現在の市場価格に基づいてシステムが自動的に入札するスポットインスタンス	NoSpot
Amount	integer	インスタンスの数です。	1
InstanceChargeType	string	インスタンスの課金方法です。有効な値は次のとおりです： Prepaid：サブスクリプション PostPaid：従量課金	PostPaid

例

成功レスポンス

JSONJSON

{
  "ScalingActivityId": "asa-bp175o6f6ego3r2j****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "ActivityType": "CapacityChange",
  "PlanResult": {
    "ResourceAllocations": [
      {
        "ZoneId": "cn-beijing-g",
        "InstanceType": "ecs.u1-c1m8.large",
        "SpotStrategy": "NoSpot",
        "Amount": 1,
        "InstanceChargeType": "PostPaid"
      }
    ]
  }
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。