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

スケーリンググループから Application Load Balancer (ALB) サーバーグループをデタッチします。DetachAlbServerGroups API を呼び出す際、スケーリンググループ ID、ALB サーバーグループ ID、および対象の ALB サーバーグループ内の Elastic Compute Service (ECS) インスタンスが使用するポートを指定して、スケーリンググループから 1 つ以上の ALB サーバーグループをデタッチできます。

今すぐお試しください

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

update

*ScalingGroup

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	スケーリンググループが属するリージョン ID。例： cn-hangzhou および cn-shanghai。	cn-hangzhou
ScalingGroupId	string	必須	スケーリンググループの ID。	asg-bp18p2yfxow2dloq****
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアント側で値を生成できますが、異なるリクエスト間で一意である必要があります。トークンは ASCII 文字のみで構成され、長さは 64 文字を超えることはできません。詳細については、「リクエストのべき等性を保証する方法」をご参照ください。	123e4567-e89b-12d3-a456-42665544****
ForceDetach	boolean	任意	デタッチする ALB サーバーグループから、既存の ECS インスタンスを削除するかどうかを指定します。有効な値： true ：既存の ECS インスタンスを ALB サーバーグループから削除し、`ScalingActivityId` の値を返します。`ScalingActivityId` の値をクエリすることで、既存の ECS インスタンスが ALB サーバーグループから削除されたかどうかを確認できます。 false ：既存の ECS インスタンスを ALB サーバーグループから削除しません。デフォルト値： false。	false
AlbServerGroups	array<object>	必須	ALB サーバーグループの詳細。
	object	任意	ALB サーバーグループの詳細。
AlbServerGroupId	string	必須	ALB サーバーグループの ID。	sgp-ddwb0y0g6y9bjm****
Port	integer	必須	ALB サーバーグループ内の ECS インスタンスが使用するポート番号。	22

レスポンスフィールド

フィールド	型	説明	例
	object
ScalingActivityId	string	ALB サーバーグループがスケーリンググループからデタッチされ、既存の ECS インスタンスが ALB サーバーグループから削除される際のスケーリングアクティビティの ID。このパラメーターは、`ForceDetach` を `true` に設定した場合にのみ値を返します。	asa-2ze6wxj8vsohn6j9****
RequestId	string	リクエストの ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

例

成功レスポンス

JSONJSON

{
  "ScalingActivityId": "asa-2ze6wxj8vsohn6j9****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

エラーコード

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

変更履歴

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