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

スケーリンググループから 1 つ以上のサーバーグループを削除します。サポートされているサーバーグループタイプには、Application Load Balancer (ALB)、Network Load Balancer (NLB)、および Gateway Load Balancer (GWLB) が含まれます。この操作により、負荷分散ポリシーが動的に調整され、変動するワークロードをハンドルするための動的なインスタンススケーリングが必要で、アプリケーションをアクティブな状態に維持するシナリオにおけるシステムの高可用性が向上します。

今すぐお試しください

この 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:DetachServerGroups

update

*スケーリンググループ。

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	スケーリンググループのリージョン ID。	cn-hangzhou
ScalingGroupId	string	必須	スケーリンググループの ID。	asg-bp18p2yfxow2dloq****
ClientToken	string	任意	リクエストのべき等性を確保します。クライアント側で値を生成して、異なるリクエスト間で値が一意になるようにします。値には ASCII 文字のみ使用でき、長さは 64 文字以下にする必要があります。詳細については、「べき等性を確保する方法」を参照してください。	123e4567-e89b-12d3-a456-42665544****
ForceDetach	boolean	任意	現在のスケーリンググループ内の ECS インスタンスまたは ECI インスタンスを、デタッチするサーバーグループから削除するかどうかを指定します。有効な値: true: インスタンスを削除します。 false: インスタンスを削除しません。デフォルト値: false。	false
ServerGroup	array<object>	必須	負荷分散サーバーグループの情報。
	object	任意	負荷分散サーバーグループの情報。
ServerGroupId	string	必須	負荷分散サーバーグループの ID。	sgp-1gv2uidn2msy****
Type	string	必須	負荷分散サーバーグループのタイプ。有効な値: ALB: Application Load Balancer (ALB) 負荷分散。 NLB: Network Load Balancer (NLB) 負荷分散。 GWLB: Gateway Load Balancer (GWLB) 負荷分散。	ALB
Port	integer	任意	負荷分散サーバーグループ内の ECS インスタンスまたは ECI インスタンスが使用するポート番号。説明このパラメーターは、ALB および NLB 負荷分散では必須です。GWLB 負荷分散の場合、このパラメーターの設定項目はサポートされておらず、デフォルト値は 6081 です。	22

レスポンスフィールド

フィールド	型	説明	例
	object
ScalingActivityId	string	負荷分散サーバーグループがデタッチされ、サーバーグループ内の ECS インスタンスまたは ECI インスタンスが削除されたときにトリガーされるスケーリングアクティビティの ID。説明このパラメーターは、ForceDetach が true にセットされている場合にのみ返されます。	asa-bp1gbswjhjrw8tko****
RequestId	string	リクエストの ID。	6EF9BFEE-FE07-4627-B8FB-14326FB9****

例

成功レスポンス

JSONJSON

{
  "ScalingActivityId": "asa-bp1gbswjhjrw8tko****",
  "RequestId": "6EF9BFEE-FE07-4627-B8FB-14326FB9****"
}

エラーコード

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

変更履歴

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