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

スケーリンググループからインスタンスを削除します。有効なスケーリンググループで実行中のスケーリングアクティビティがない場合、 DetachInstances API を呼び出して、1 つ以上の Elastic Compute Service (ECS) インスタンス、エラスティックコンテナインスタンス、または Alibaba Cloud ホスト型のサードパーティーインスタンスをスケーリンググループから削除できます。

今すぐお試しください

この 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-bp1igpak5ft1flyp****
DecreaseDesiredCapacity	boolean	任意	スケーリンググループの希望するインスタンス数を調整するかどうかを指定します。有効な値： true：スケーリンググループから指定された数のインスタンスが削除された後、スケーリンググループの希望するインスタンス数が減少します。 false：スケーリンググループから指定された数のインスタンスが削除された後、スケーリンググループの希望するインスタンス数は変更されません。デフォルト値： true。	true
DetachOption	string	任意	削除対象としてマークされた ECS インスタンスまたはエラスティックコンテナインスタンスを、関連付けられたロードバランサーからデタッチするかどうか、およびこれらのインスタンスのプライベート IP アドレスを、関連付けられた ApsaraDB RDS インスタンスの IP アドレスホワイトリストから削除するかどうかを指定します。 Both：削除対象としてマークされた ECS インスタンスまたはエラスティックコンテナインスタンスを、関連付けられたロードバランサーからデタッチし、これらのインスタンスのプライベート IP アドレスを、関連付けられた ApsaraDB RDS インスタンスの IP アドレスホワイトリストから削除します。説明このパラメーターは、Alibaba Cloud ホスト型のサードパーティーインスタンスをスケーリンググループから削除する場合はサポートされません。	both
InstanceIds	array	必須	スケーリンググループから削除する ECS インスタンス、エラスティックコンテナインスタンス、または Alibaba Cloud ホスト型のサードパーティーインスタンスの ID。
	string	任意	スケーリンググループから削除する ECS インスタンス、エラスティックコンテナインスタンス、または Alibaba Cloud ホスト型のサードパーティーインスタンスの ID。例： ECS インスタンス： `i-bp109k5j3dum1ce6**` エラスティックコンテナインスタンス： `eci-bp17gw49eu09yiwm` Alibaba Cloud ホスト型のサードパーティーインスタンス： `mi-d23fsd****` 説明一度に削除できるインスタンスは 1 種類のみです。	i-bp109k5j3dum1ce6****
LifecycleHook	boolean	任意	ECS インスタンスまたはエラスティックコンテナインスタンスがスケーリンググループから削除されるときに、スケールイン用のライフサイクルフックをトリガーするかどうかを指定します。有効な値： true false 説明このパラメーターは、Alibaba Cloud ホスト型のサードパーティーインスタンスをスケーリンググループから削除する場合はサポートされません。デフォルト値： false。	false
IgnoreInvalidInstance	boolean	任意	スケーリンググループからインスタンスを一括で削除するときに、無効なインスタンスを無視するかどうかを指定します。有効な値： true：無効なインスタンスを無視します。無効なインスタンスが存在し、有効なインスタンスがスケーリンググループから削除された場合、対応するスケーリングアクティビティは警告状態になります。スケーリングアクティビティの詳細を確認して、無視された無効なインスタンスを表示できます。 false：無効なインスタンスを無視しません。スケーリンググループから削除するインスタンスのバッチに無効なインスタンスが存在する場合、エラーが報告されます。デフォルト値： false。	false
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、トークンが異なるリクエスト間で一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。詳細については、「べき等性の確保」をご参照ください。	123e4567-e89b-12d3-a456-42665544****

レスポンスフィールド

フィールド	型	説明	例
	object
ScalingActivityId	string	スケーリングアクティビティの ID。	asa-bp1gbswjhjrw8tko****
RequestId	string	リクエストの ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

例

成功レスポンス

JSONJSON

{
  "ScalingActivityId": "asa-bp1gbswjhjrw8tko****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

エラーコード

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

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

変更履歴

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