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

指定された調整ルールに基づいて弾力的スケーリングをトリガーします。

操作説明

この操作を呼び出す前に、以下の条件が満たされていることを確認してください:
- スケーリンググループがアクティブな状態であること。
- スケーリンググループでスケーリングアクティビティが進行中でないこと。
スケーリンググループでスケーリングアクティビティが進行中でない場合、この操作はクールダウン時間をバイパスし、スケーリングアクティビティを直接トリガーできます。
スケーリングルールに基づいて追加される ECS インスタンス数とスケーリンググループの現在のインスタンス数 (Total Capacity) の合計が最大値 (MaxSize) を超える場合、スケーリングアクティビティは Total Capacity を MaxSize にセットして実行されます。
スケーリンググループの現在のインスタンス数 (Total Capacity) からスケーリングルールに基づいて削除される ECS インスタンス数を引いた値が最小値 (MinSize) を下回る場合、スケーリングアクティビティは Total Capacity を MinSize にセットして実行されます。

成功した応答は、Auto Scaling がリクエストを受け付け、スケーリングアクティビティを実行できることのみを示します。スケーリングアクティビティが成功することを意味するものではありません。返された 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 インスタンス数は 1000 を超えることはできません。超えた場合、調整は失敗します。調整メソッドごとの有効な値: QuantityChangeInCapacity: -1000～1000。 PercentChangeInCapacity: -100～10000。 TotalCapacity: 0～2000。	100
MinAdjustmentMagnitude	integer	任意	スケーリングアクティビティで調整するインスタンスの最小値。このパラメーターは、AdjustmentType が PercentChangeInCapacity にセットされている場合にのみ効果があります。	1
ClientToken	string	任意	リクエストのべき等性を確保し、重複送信を防止するために使用されるクライアントトークン。値はクライアントによって生成され、異なるリクエスト間で一意である必要があります。値は最大 64 文字の ASCII 文字で、非 ASCII 文字を含めることはできません。	123e4567-e89b-12d3-a456-42665544****
SyncActivity	boolean	任意	スケーリングアクティビティを同期的に実行するかどうかを指定します。このパラメーターは、期待されるインスタンス数が設定されているスケーリンググループにのみ有効です。有効な値: true: 同期実行。スケーリングルールがスケーリンググループのスケーリングアクティビティを直接トリガーします。 false: 非同期実行。スケーリンググループの期待されるインスタンス数が変更済みでも、スケーリングアクティビティはすぐにはトリガーされません。システムは期待されるインスタンス数と現在のインスタンス数の差異を検出するまで待機し、その後スケーリングアクティビティをトリガーします。説明期待されるインスタンス数の詳細については、期待されるインスタンス数を参照してください。デフォルト値: false。	false
Overrides	object	任意	ECI タイプのスケーリンググループにおけるスケールアウトのオーバーライドパラメーター。
Cpu	number	任意	インスタンスレベルの vCPU 数。単位: コア。	2
Memory	number	任意	インスタンスレベルのメモリサイズ。単位: GiB。	4
UserData	string	任意
ContainerOverride	array<object>	任意	コンテナリストのオーバーライドパラメーター。
	array<object>	任意	コンテナリストのオーバーライドパラメーター。
Command	array	任意	コンテナの起動コマンド。最大 20 個のコマンドがサポートされています。各コマンドは最大 256 文字です。
	string	任意	コンテナの起動コマンド。最大 20 個のコマンドがサポートされています。各コマンドは最大 256 文字です。	sleep
Memory	number	任意	コンテナのメモリサイズ。単位: GiB。	4
Arg	array	任意	コンテナ起動コマンドの引数。最大 10 個の引数がサポートされています。
	string	任意	コンテナ起動コマンドの引数。最大 10 個の引数がサポートされています。	arg
Cpu	number	任意	コンテナの vCPU 数。単位: コア。	2
EnvironmentVar	array<object>	任意	環境変数情報のリスト。
	object	任意	環境変数情報のリスト。
Value	string	任意	Environment variable value. Length: 0 to 256 characters.	/usr/local/tomcat
Key	string	任意	Environment variable name. Length: 1 to 128 characters. Format requirements: `[0-9a-zA-Z]` and underscores (_); must not start with a digit.	PATH
Name	string	任意	コンテナ名。コンテナパラメーターをオーバーライドする場合は、コンテナ名を指定する必要があります。コンテナパラメーターは、コンテナ名がスケーリング設定のコンテナ名と一致する場合にのみオーバーライドできます。	container-1
LifecycleHookContext	object	任意	ライフサイクルフックのコンテキスト情報。
DisableLifecycleHook	boolean	任意	スケーリングアクティビティのすべてのライフサイクルフック機能を無効にするかどうかを指定します。有効な値: true: 無効にします。 false: 無効にしません。	false
IgnoredLifecycleHookIds	array	任意	スケーリングアクティビティで無効にするライフサイクルフック ID のリスト。
	string	任意	スケーリングアクティビティで無効にするライフサイクルフック ID のリスト。	ash-bp14zolna43z266bq***
LifecycleHookResult	string	任意
ActivityMetadata	string	任意	スケーリングアクティビティのメタデータ。	{"key":"value"}
ExecutionMode	string	任意	実行モード。有効な値: None: 指定なし。通常のスケーリングが実行されます。 PlanOnly: スケーリングはトリガーされません。弾力的計画のみが実行され、計画結果がインスタンスタイプ、ゾーン ID、課金方法、作成するインスタンス数を含む PlanResult で返されます。デフォルト値: None。	PlanOnly

レスポンスフィールド

フィールド	型	説明	例
	object	指定された調整ルールに基づいて弾力的スケーリングをトリガーするためのレスポンスパラメーター。
ScalingActivityId	string	スケーリングアクティビティの ID。	asa-bp175o6f6ego3r2j****
RequestId	string	リクエスト ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
ActivityType	string	スケーリングアクティビティのタイプ。 `ActivityType` が `CapacityChange` にセットされている場合、返された `ScalingActivityId` に対応するスケーリングアクティビティは、スケーリンググループの期待されるインスタンス数のみを変更し、すぐにスケーリングを実行しません。スコープ: 期待されるインスタンス数が設定されているスケーリンググループ。	CapacityChange
PlanResult	object	ExecutionMode が PlanOnly に設定されている場合に返される弾力的計画の結果。
ResourceAllocations	array<object>	弾力的計画結果のリソース割り当て情報。
	object
ZoneId	string	Zone ID.	cn-beijing-g
InstanceType	string	Instance type.	ecs.u1-c1m8.large
SpotStrategy	string	The spot strategy of the instance. Valid values: NoSpot: A normal pay-as-you-go instance. SpotWithPriceLimit: A spot instance with a specified maximum price. SpotAsPriceGo: A spot instance for which the system automatically bids based on the current marketplace price.	NoSpot
Amount	integer	Number of instances.	1
InstanceChargeType	string	Billing method. Valid return values are as follows: Prepaid: subscription. Postpaid: pay-as-you-go.	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"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
403	Forbidden.Forbidden	Operation Forbidden

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

変更履歴

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