ListServerGroupServers API によるサーバーグループ内のサーバー一覧 - ALB - Alibaba Cloud - Server Load Balancer

サーバーグループ内のサーバーを照会します。

今すぐお試しください

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

get

*ServerGroup

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
NextToken	string	任意	次のリクエストで新しいページの結果を取得するために使用されるページネーショントークン。有効な値: 最初のリクエスト、または次のクエリが存在しない場合は、このパラメーターを指定する必要はありません。次のクエリが存在する場合は、前の API 呼び出しで返された NextToken の値を設定します。	FFmyTO70tTpLG6I3FmYAXG****
MaxResults	integer	任意	このリクエストで返すレコードの最大値。有効な値: 1 ～ 100。このパラメーターが指定されていない場合、デフォルト値は 20 です。	50
ServerGroupId	string	任意	サーバーグループの ID。	sgp-cb25e2i2vr******
ServerIds	array	任意	サーバー ID のリスト。
	string	任意	サーバーの ID。1 回の呼び出しで表示できるサーバーの最大値は 40 です。サーバーグループタイプが Instance の場合、このパラメーターは ECS インスタンス、ENI、または ECI インスタンスのリソース ID を指定します。サーバーグループタイプが Ip の場合、このパラメーターは IP アドレスを指定します。サーバーグループタイプが Fc の場合、このパラメーターは Function Compute 関数の Amazon リソースネーム (ARN) を指定します。	i-bp1e0u8f10by57wl****
Tag	array<object>	任意	サーバーグループにバインドされているタグ。1 回のリクエストで最大 10 個のタグを指定できます。
	object	任意	サーバーグループにバインドされているタグ。1 回のリクエストで最大 10 個のタグを指定できます。
Key	string	任意	タグキー。最大 10 個のタグキーを指定できます。タグキーの長さは最大 64 文字で、`aliyun` または `acs:` で始まることはできません。`http://` または `https://` を含めることはできません。	Test
Value	string	任意	タグ値。最大 10 個のタグ値を指定できます。タグ値の長さは最大 128 文字で、`aliyun` または `acs:` で始まることはできません。`http://` または `https://` を含めることはできません。	Test

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンス構造体。
MaxResults	integer	このリクエストで返されるレコードの最大値。	50
NextToken	string	次のリクエストで新しいページの結果を取得するために使用されるページネーショントークン。有効な値: NextToken が空の場合、次のクエリは存在しません。 NextToken が返された場合、その値は次のクエリのトークンを示します。	caeba0bbb2be03f8****
RequestId	string	リクエストの ID。	CEF72CEB-54B6-4AE8-B225-F876FF*****
Servers	array<object>	サーバーのリスト。
	object	バックエンドサーバーの構造体。
Description	string	バックエンドサーバーの説明。	test
Port	integer	バックエンドサーバーで使用されるポート。有効な値: 1 ～ 65535。	80
ServerId	string	バックエンドサーバーの ID。説明 ServerType が Fc に設定されている場合、ServerId は Function Compute 関数の ARN を指定します。	i-bp1f9kdprbgy9uiu****
ServerIp	string	指定された IP アドレス。	192.168.XX.XX
ServerType	string	バックエンドサーバーのサーバータイプ。	Ecs
Status	string	バックエンドサーバーのステータス。有効な値: Adding: 追加中。 Available: 利用可能。 Configuring: 設定中。 Removing: 削除中。	Available
Weight	integer	バックエンドサーバーの重み。重みが大きいサーバーほど多くのリクエストを受け取ります。	100
ServerGroupId	string	サーバーグループの ID。	sgp-qy042e1jabmprh****
RemoteIpEnabled	boolean	リモート IP が有効かどうかを示します。有効な値: true: 有効。 false: 無効。	true
TotalCount	integer	指定されたフィルター条件に一致するレコードの総数。	3

例

成功レスポンス

JSONJSON

{
  "MaxResults": 50,
  "NextToken": "caeba0bbb2be03f8****",
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF*****",
  "Servers": [
    {
      "Description": "test",
      "Port": 80,
      "ServerId": "i-bp1f9kdprbgy9uiu****",
      "ServerIp": "192.168.XX.XX",
      "ServerType": "Ecs",
      "Status": "Available",
      "Weight": 100,
      "ServerGroupId": "sgp-qy042e1jabmprh****",
      "RemoteIpEnabled": true
    }
  ],
  "TotalCount": 3
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
403	Forbidden.ServerGroup	Authentication has failed for ServerGroup.

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

変更履歴

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