GWLB サーバーグループからバックエンドサーバーを削除 - Server Load Balancer (SLB)

Gateway Load Balancer (GWLB) インスタンスのサーバーグループからバックエンドサーバーを削除します。

操作説明

RemoveServersFromServerGroup は非同期操作です。リクエストの送信後、システムはリクエスト ID を返し、バックグラウンドでタスクを実行します。

ListServerGroups 操作を呼び出して、サーバーグループのステータスをクエリできます。
- サーバーグループが 設定中 状態の場合、サーバーグループは変更中です。
- サーバーグループが 利用可能 状態の場合、サーバーグループは実行中です。
ListServerGroupServers 操作を呼び出して、バックエンドサーバーのステータスをクエリできます。
- バックエンドサーバーが 削除中 状態の場合、バックエンドサーバーはサーバーグループから削除中です。
- バックエンドサーバーが見つからない場合、バックエンドサーバーはサーバーグループに存在しなくなっています。

説明

バックエンドサーバーのサーバーグループで接続ドレインが有効になっている (ConnectionDrainEnabled が true に設定されている) 場合、削除するバックエンドサーバーは 削除中 状態になり、その後 ドレイン中 状態に移行します。接続ドレインのタイムアウト期間 (ConnectionDrainTimeout) が終了すると、バックエンドサーバーはサーバーグループから削除されます。
接続ドレインのタイムアウト期間が終了する前に、バックエンドサーバーをサーバーグループに再度追加できます。この場合、バックエンドサーバーのステータスは ドレイン中 から 追加中 に変わります。バックエンドサーバーがサーバーグループに追加されると、バックエンドサーバーは 利用可能 状態になります。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

gwlb:RemoveServersFromServerGroup

delete

*ServerGroup

acs:gwlb:{#regionId}:{#accountId}:servergroup/{#ServerGroupId}

Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#InstanceId}

NetworkInterface

acs:ecs:{#regionId}:{#accountId}:eni/{#ServerId}

ContainerGroup

acs:eci:{#regionId}:{#accountId}:containergroup/{#ServerId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ServerGroupId	string	必須	サーバーグループ ID。	sgp-atstuj3rtoptyui****
Servers	array<object>	必須	削除するバックエンドサーバー。説明各呼び出しで最大 200 台のバックエンドサーバーを削除できます。
	object	任意	バックエンドサーバー。
Port	integer	任意	バックエンドサーバーが使用するポート。有効な値： 6081	6081
ServerId	string	必須	バックエンドサーバー ID。サーバーグループのタイプが Instance の場合、このパラメーターを Ecs、Eni、または Eci タイプのサーバーの ID に設定します。サーバーグループのタイプが Ip の場合、ServerId を IP アドレスに設定します。	i-bp67acfmxazb4p****
ServerIp	string	任意	バックエンドサーバーの IP アドレス。	192.168.xxx.xxx
ServerType	string	必須	バックエンドサーバーのタイプ。有効な値： Ecs：Elastic Compute Service (ECS) インスタンス Eni：Elastic Network Interface (ENI) Eci：Elastic Container Instance Ip：IP アドレス	Ecs
DryRun	boolean	任意	実際のリクエストを実行せずに、ドライランのみを実行するかどうかを指定します。有効な値： true：ドライランのみを実行します。システムは、パラメーター値の欠落、リクエスト構文の誤り、サービスの制限など、リクエストに潜在的な問題がないか確認します。リクエストがドライランに失敗すると、エラーコードが返されます。リクエストがドライランに成功すると、`DryRunOperation` エラーコードが返されます。 false (デフォルト)：ドライランを実行し、実際のリクエストを実行します。リクエストがドライランに成功すると、2xx HTTP ステータスコードが返され、操作が実行されます。	false
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、トークンが異なるリクエスト間で一意であることを確認する必要があります。クライアントトークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは自動的にリクエスト ID をクライアントトークンとして使用します。リクエスト ID はリクエストごとに異なる場合があります。	123e4567-e89b-12d3-a456-42665544****

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエスト ID。	54B48E3D-DF70-471B-AA93-08E683A1B45

例

成功レスポンス

JSONJSON

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	IncorrectStatus.BackendServer	The status of %s [%s] is incorrect.
400	IncorrectStatus.ServerGroup	The status of %s [%s] is incorrect.
404	ResourceNotFound.BackendServer	The specified resource of %s is not found.
404	ResourceNotFound.ServerGroup	The specified resource of %s is not found.

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

変更履歴

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