GWLB サーバーグループにバックエンドサーバーを追加 - Gateway Load Balancer

サーバーグループにバックエンドサーバーを追加します。

操作説明

AddServersToServerGroup は非同期操作です。リクエストを送信した後、システムはリクエスト ID を返しますが、バックエンドサーバーはサーバーグループにすぐには追加されません。システムはバックグラウンドでバックエンドサーバーを追加します。

ListServerGroups 操作を呼び出して、サーバーグループのステータスをクエリできます。

サーバーグループが [構成中] 状態の場合、サーバーグループは変更中です。
サーバーグループが [利用可能] 状態の場合、サーバーグループは実行中です。

ListServerGroupServers 操作を呼び出して、バックエンドサーバーのステータスをクエリできます。

バックエンドサーバーが [追加中] 状態の場合、バックエンドサーバーはサーバーグループに追加中です。
バックエンドサーバーが [利用可能] 状態の場合、バックエンドサーバーは実行中です。

今すぐお試しください

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

create

*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 です。サーバーグループのタイプが [インスタンス] の場合、このパラメーターは ECS インスタンス、 ENI 、または ECI インスタンスの ID を指定します。サーバーグループのタイプが [IP] の場合、このパラメーターは IP アドレスを指定します。	i-bp67acfmxazb4p****
ServerIp	string	任意	バックエンドサーバーの IP アドレスです。	192.168.XX.XX
ServerType	string	必須	バックエンドサーバーのタイプです。有効な値： Ecs: ECS インスタンス。 Eni: 弾性ネットワークインターフェース (ENI)。 Eci: 弾性コンテナインスタンス。 Ip: IP アドレス。	Ecs
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。有効な値： true: ドライランを実行します。システムは必須パラメーター、リクエストフォーマット、およびサービス制限を確認します。リクエストがドライランに失敗した場合、エラーメッセージが返されます。リクエストがドライランに合格した場合、`DryRunOperation` エラーコードが返されます。 false (デフォルト): リクエストを送信します。リクエストがチェックに合格した場合、2xx HTTP ステータスコードが返され、操作が実行されます。	false
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークンです。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムはリクエストの RequestId を ClientToken として自動的に使用します。 RequestId はリクエストごとに異なる場合があります。	123e4567-e89b-12d3-a456-426655440000

レスポンスパラメーター

パラメーター	タイプ	説明	例
	object	レスポンスのデータ構造です。
RequestId	string	リクエスト ID です。	54B48E3D-DF70-471B-AA93-08E683A1B45

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	Conflict.Server	The %s [%s] is conflict.
400	Mismatch.ServerType	The %s is mismatched for %s and %s.
400	ResourceInUse.IP	The specified resource of %s is in use.
400	IllegalParam.ServerIp	The param of %s is illegal.
400	IllegalParam.EcsNetworkType	The param of %s is illegal.
400	DuplicatedParam.Server	The param of %s is duplicated.
400	ResourceInUse.Eni	The specified resource of %s is in use.
400	IncorrectStatus.Eni	The status of %s [%s] is incorrect.
400	IllegalParam.IP	The param of %s is illegal.
400	Mismatch.IP	The %s is mismatched for %s and %s.
400	Mismatch.VpcId	The %s is mismatched for %s and %s.
400	QuotaExceeded.ServerGroupServersNum	The quota of %s is exceeded for resource %s, usage %s/%s.
400	QuotaExceeded.ServerGroupAzServersNum	The quota of %s is exceeded for resource %s, usage %s/%s.
400	IncorrectStatus.ServerGroup	The status of %s [%s] is incorrect.
404	ResourceNotFound.Eni	The specified resource of %s is not found.
404	ResourceNotFound.Eci	The specified resource of %s is not found.
404	ResourceNotFound.ServerGroup	The specified resource of %s is not found.
404	ResourceNotFound.Ecs	The specified resource of %s is not found.

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

変更履歴

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