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

スケーリンググループが有効で、進行中のスケーリングアクティビティがない場合は、RemoveInstances API を呼び出して、1 つ以上のインスタンスをグループから削除できます。

操作説明

この API を呼び出す前に、次の条件が満たされていることを確認してください。
- スケーリンググループがアクティブ状態であること。
- スケーリンググループに進行中のスケーリングアクティビティがないこと。

説明

スケーリンググループに進行中のスケーリングアクティビティがない場合、この API はクールダウン (DefaultCooldown) をバイパスできます。

ECS インスタンスが Auto Scaling によって自動的に作成された場合、または手動で追加されてスケーリンググループによって管理されている場合、スケーリンググループからインスタンスを削除すると、そのインスタンスはエコノミーモードに移行するか、リリースされます。
ECS インスタンスが手動で追加され、スケーリンググループによって管理されていない場合、グループからインスタンスを削除しても、そのインスタンスは停止またはリリースされません。
残りのインスタンス数がインスタンスの最小数 (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:DetachInstances

update

*ScalingGroup

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ScalingGroupId	string	必須	スケーリンググループの ID。	asg-bp18p2yfxow2dloq****
RemovePolicy	string	任意	削除する ECS インスタンスに対して実行するアクションを指定します。有効な値： recycle： ECS インスタンスは節約モードに移行します。説明この値は、スケーリンググループの `ScalingPolicy` パラメータが `recycle` に設定されている場合にのみ有効です。 release： ECS インスタンスはリリースされます。 `CreateScalingGroup` API の `ScalingPolicy` パラメータは、スケーリンググループの回収モードを指定します。ただし、`RemoveInstances` API の `RemovePolicy` パラメータは、インスタンスが削除されるときに実行されるアクションを決定します。例： `ScalingPolicy` が `recycle` で、`RemovePolicy` が `recycle` の場合、ECS インスタンスは節約モードに移行します。 `ScalingPolicy` が `recycle` で、`RemovePolicy` が `release` の場合、ECS インスタンスはリリースされます。 `ScalingPolicy` が `release` で、`RemovePolicy` が `recycle` の場合、ECS インスタンスはリリースされます。 `ScalingPolicy` が `release` で、`RemovePolicy` が `release` の場合、ECS インスタンスはリリースされます。デフォルト値： release。	release
DecreaseDesiredCapacity	boolean	任意	スケーリンググループの希望する容量を減らすかどうかを指定します。有効な値： `true`：スケーリンググループの希望する容量を、削除されたインスタンスの数だけ減らします。 `false`：スケーリンググループの希望する容量は変更されません。デフォルト値： true。	true
IgnoreInvalidInstance	boolean	任意	スケーリンググループから複数のインスタンスを削除する際に、無効なインスタンスを無視するかどうかを指定します。有効な値： `true`：無効なインスタンスは無視されます。無効なインスタンスが存在する状態で有効なインスタンスが削除された場合、スケーリングアクティビティのステータスは警告に設定されます。無効なインスタンスは、スケーリングアクティビティの詳細に一覧表示されます。 `false`：無効なインスタンスが含まれている場合、リクエストは拒否され、エラーが返されます。デフォルト値： false。	false
InstanceIds	array	必須	削除する ECS インスタンスの ID の配列。
	string	任意	削除する ECS インスタンスの ID。	i-28wt4****
RegionId	string	任意	スケーリンググループのリージョン ID。	cn-qingdao
ClientToken	string	任意	リクエストのべき等性を保証するためのクライアント生成トークン。このトークンは、各リクエストで一意である必要があり、ASCII 文字のみを含み、64 文字を超えてはなりません。詳細については、「べき等性を確保する方法」をご参照ください。	123e4567-e89b-12d3-a456-42665544****
StopInstanceTimeout	integer	任意	スケールイン中に ECS インスタンスが停止するまでのタイムアウト期間 (秒単位)。有効な値： 30 ~ 240。説明デフォルトでは、このパラメータはスケーリンググループから値を継承しますが、`RemoveInstances` API を呼び出す際にオーバーライドできます。このパラメータは、`RemovePolicy` が `release` に設定されているスケールインイベント中にのみ有効です。このパラメータが設定されている場合、システムはインスタンスが停止するのを、指定された期間待機します。タイムアウトが経過すると、インスタンスの状態に関係なく、スケールインプロセスは続行されます。このパラメータが設定されていない場合、システムはインスタンスが停止するまで待機してから、スケールインプロセスを続行します。インスタンスが停止に失敗した場合、スケールインプロセスはロールバックされ、失敗します。	60
LifecycleHookContext	object	任意	ライフサイクルフックのコンテキスト。
DisableLifecycleHook	boolean	任意	スケーリングアクティビティのすべてのライフサイクルフックを無効にするかどうかを指定します。有効な値： `true`：すべてのライフサイクルフックを無効にします。 `false`：ライフサイクルフックを無効にしません。	false
IgnoredLifecycleHookIds	array	任意	スケーリングアクティビティで無視するライフサイクルフック ID のリスト。
	string	任意	スケーリングアクティビティで無視するライフサイクルフックの ID。	ash-bp14zolna43z266bq***
LifecycleHookResult	string	任意

レスポンスフィールド

フィールド	型	説明	例
	object
ScalingActivityId	string	スケーリングアクティビティの ID です。	asa-bp175o6f6ego3r2j****
RequestId	string	リクエストの ID です。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
IgnoredInstances	array<object>	削除されなかったインスタンスとその理由です。
	object
InstanceId	string	削除されなかったインスタンスの ID です。
Code	string	インスタンスが削除されなかった理由を示すエラーコードです。
Message	string	インスタンスが削除されなかった理由を示すエラーメッセージです。

例

成功レスポンス

JSONJSON

{
  "ScalingActivityId": "asa-bp175o6f6ego3r2j****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "IgnoredInstances": [
    {
      "InstanceId": "",
      "Code": "",
      "Message": ""
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
500	InternalError	The request processing has failed due to some unknown error, exception or failure.

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

変更履歴

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