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

スケーリンググループから Classic Load Balancer (CLB、旧称 Server Load Balancer (SLB)) インスタンスをデタッチします。現在の CLB インスタンスがビジネス要件を満たさなくなった場合、DetachLoadBalancers API を呼び出して、スケーリンググループからインスタンスをデタッチできます。この API を呼び出す際、ScalingGroupId、LoadBalancers、および ForceDetach を使用して、デタッチする 1 つ以上の CLB インスタンスを指定できます。また、この API を非同期で呼び出すかどうか、およびバックエンドサーバーとして機能する Elastic Compute Service (ECS) インスタンスを CLB インスタンスのバックエンドサーバーグループから削除するかどうかを指定できます。この API を呼び出して、スケーリンググループからデタッチできるのは CLB インスタンスのみです。

今すぐお試しください

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

update

*ScalingGroup

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ScalingGroupId	string	必須	スケーリンググループの ID。	asg-bp1ffogfdauy0jw0****
ForceDetach	boolean	任意	スケーリンググループ内の ECS インスタンスをロードバランサーのバックエンドサーバーグループから削除するかどうかを指定します。有効な値： true false デフォルト値：false。	false
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークンです。クライアントを使用して値を生成できますが、異なるリクエスト間で値が一意であることを保証する必要があります。トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。詳細については、「べき等性を確保する方法」をご参照ください。	123e4567-e89b-12d3-a456-42665544****
Async	boolean	任意	CLB インスタンスをスケーリンググループから非同期でデタッチするかどうかを指定します。CLB インスタンスをスケーリンググループから非同期でデタッチする場合、すべての操作が成功した後にのみ呼び出しは成功します。特定の操作が失敗した場合、呼び出しは失敗します。このパラメーターを `true` に設定することを推奨します。有効な値： `true`：CLB インスタンスをスケーリンググループから非同期でデタッチします。この場合、スケーリングアクティビティの ID が返されます。 `false`：CLB インスタンスをスケーリンググループから非同期でデタッチしません。デフォルト値：false。	false
LoadBalancers	array	必須	CLB インスタンスの ID。最大 5 つのインスタンス ID を指定できます。
	string	任意	CLB インスタンスの ID。最大 5 つのインスタンス ID を指定できます。	lb-2zeur05gfs****
RegionId	string	任意	スケーリンググループのリージョン ID。	cn-qingdao

レスポンスフィールド

フィールド	型	説明	例
	object
ScalingActivityId	string	スケーリングアクティビティの ID。このパラメーターは、`Async` パラメーターを `true` に設定した場合にのみ返されます。`DescribeScalingActivities` API を呼び出してすべてのスケーリングアクティビティ ID を照会し、その ID を使用してスケーリングアクティビティのステータスを確認できます。	asa-bp140qd7mak8k63f****
RequestId	string	リクエスト ID です。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

例

成功レスポンス

JSONJSON

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

エラーコード

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

変更履歴

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