AddServersToServerGroup - - Alibaba Cloud ドキュメントセンター

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

操作説明

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

ListServerGroups を呼び出して、サーバーグループのステータスをクエリします:

サーバーグループが Configuring 状態の場合、サーバーグループの構成が変更されています。
サーバーグループが Available 状態の場合、サーバーグループは実行中です。

ListServerGroupServers を呼び出して、バックエンドサーバーのステータスをクエリします:

バックエンドサーバーが Adding 状態の場合、サーバーグループに追加されています。
バックエンドサーバーが Available 状態の場合、実行中です。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

alb:AddServersToServerGroup

create

*ServerGroup

acs:alb:{#regionId}:{#accountId}:servergroup/{#servergroupId}

Instance

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

NetworkInterface

acs:alb:{#regionId}:{#accountId}:eni/{#NetworkInterfaceId}

ContainerGroup

acs:alb:{#regionId}:{#accountId}:eci/{#ContainerGroupId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ServerGroupId	string	必須	サーバーグループの ID。	sgp-atstuj3rtop****
Servers	array<object>	必須	バックエンドサーバーのリスト。1 回の呼び出しで最大 200 台のサーバーを追加できます。
	object	任意	バックエンドサーバー。
Description	string	任意	バックエンドサーバーの説明。説明は 2～256 文字で、http:// または https:// で始めることはできません。	test
Port	integer	任意	バックエンドサーバーが使用するポート。有効な値: 1～65535。1 回の呼び出しで最大 200 台のサーバーを追加できます。説明このパラメーターは、ServerType が Ecs、Eni、Eci、または Ip に設定されている場合に必須です。ServerType が Fc に設定されている場合、このパラメーターを設定する必要はありません。	80
ServerId	string	必須	バックエンドサーバーの ID。1 回の呼び出しで最大 200 台のサーバーを追加できます。サーバーグループが Instance タイプの場合、このパラメーターを ECS インスタンス、ENI、または ECI インスタンスの ID に設定します。サーバーグループが Ip タイプの場合、このパラメーターを IP アドレスに設定します。サーバーグループが Fc タイプの場合、このパラメーターを Function Compute の関数の Alibaba Cloud リソースネーム (ARN) に設定します。	i-uf616vu8me******
ServerIp	string	任意	バックエンドサーバーの IP アドレス。1 回の呼び出しで最大 200 台のサーバーを追加できます。 ServerType が Eni に設定されている場合、ENI のプライマリプライベート IP アドレスまたはセカンダリプライベート IP アドレスを指定できます。説明 ServerType が Fc に設定されている場合、このパラメーターを設定する必要はありません。	192.168.1.1
ServerType	string	必須	バックエンドサーバーのタイプ。1 回の呼び出しで最大 200 台のサーバーを追加できます。有効な値: Ecs: ECS インスタンス。 Eni: ENI。 Eci: ECI。 Ip: IP アドレス。 Fc: Function Compute の関数。	Ecs
Weight	integer	任意	バックエンドサーバーの重み。有効な値: 0～100。デフォルト値: 100。重みを 0 に設定した場合、リクエストはバックエンドサーバーに転送されません。1 回の呼び出しで最大 200 台のサーバーを追加できます。説明 ServerType が Fc に設定されている場合、このパラメーターを設定する必要はありません。	100
RemoteIpEnabled	boolean	任意	リモート IP 機能を有効にするかどうかを指定します。1 回の呼び出しで最大 200 台のサーバーを追加できます。有効な値: true: 有効。 false: 無効。説明このパラメーターは、ServerType が Ip に設定されている場合にのみ有効です。	false
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントでトークンを生成して、異なるリクエスト間でトークンが一意であることを確認します。トークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは自動的にリクエストの RequestId を ClientToken として使用します。各 API リクエストの RequestId は異なる場合があります。	593B0448-D13E-4C56-AC0D-FDF0******
DryRun	boolean	任意	ドライランを実行するかどうかを指定します。有効な値: true: ドライランを実行します。システムは、必須パラメーター、リクエストフォーマット、およびサービス制限を確認します。リクエストがドライランに失敗した場合、エラーが返されます。リクエストがドライランに成功した場合、`DryRunOperation` エラーコードが返されます。ドライランでは、バックエンドサーバーは追加されません。 false (デフォルト): リクエストを送信します。リクエストがチェックに合格すると、2xx HTTP ステータスコードが返され、操作が実行されます。	false

レスポンスフィールド

フィールド	型	説明	例
	object	返されたデータ。
JobId	string	非同期タスクの ID。	72dcd26b-f12d-4c27-b3af-18f6aed5****
RequestId	string	リクエスト ID。	365F4154-92F6-4AE4-92F8-7FF34******

例

成功レスポンス

JSONJSON

{
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34******"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	ResourceQuotaExceeded.ServerAddedNum	The quota of %s is exceeded for resource %s, usage %s/%s.
400	IncorrectStatus.ServerGroup	The status of %s [%s] is incorrect.
400	Conflict.BackendServer	There is already %s having the same configuration with %s.
400	OperationDenied.VpcVportNotFound	The operation is not allowed because of %s.
400	IncorrectStatus.Eni	The status of %s [%s] is incorrect.
400	ResourceInUse.IP	The specified resource %s is in use.
400	OperationDenied.NoAvailableVSwitch	The operation is not allowed because of %s.
400	OperationDenied.VgwVipNotFound	The operation is not allowed because of %s.
400	OperationDenied.CloudBox	The operation is not allowed because of %s.
400	Mismatch.Type	The %s is mismatched for %s and %s.
400	Mismatch.VpcId	The %s is mismatched for %s and %s.
400	ResourceQuotaExceeded.LoadBalancerServersNum	The quota of %s is exceeded for resource %s, usage %s/%s.
400	ResourceInConfiguring	The specified resource of %s is being configured. Please try again later.
400	DuplicatedParam.BackendServer	The param of %s is duplicated.
400	OperationDenied.EciNotSupportJobType	The operation is not allowed because of eci not support job type.
400	IllegalParam.ServerIp	The param of ServerIp is illegal.
400	Mismatch.ServerType	The %s is mismatched for %s and %s.
400	ServiceUnavailable	The request has failed due to a temporary failure of the server.
403	Forbidden.ServerGroup	Authentication has failed for ServerGroup.
404	ResourceNotFound.ServerGroup	The specified resource %s is not found.
404	ResourceNotFound.Ecs	The specified resource %s is not found.
404	ResourceNotFound.Eci	The specified resource %s is not found.
404	ResourceNotFound.Eni	The specified resource %s is not found.

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

変更履歴

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