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

サーバーグループ内のサーバーを一覧表示します。

今すぐお試しください

この 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。各呼び出しで最大 40 個のサーバー ID を指定できます。サーバーグループが Instance タイプの場合、このパラメーターは Elastic Compute Service (ECS) インスタンス、Elastic Network Interface (ENI)、または Elastic Container Instance (ECI) の ID を指定します。サーバーグループが Ip タイプの場合、このパラメーターは IP アドレスを指定します。サーバーグループが Fc タイプの場合、このパラメーターは Function Compute 関数の Alibaba Cloud リソースネーム (ARN) を指定します。	i-bp1e0u8f10by57wl****
Tag	array<object>	任意	タグ。リクエストで最大 10 個のタグを指定できます。
	object	任意	タグ。リクエストで最大 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.

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

変更履歴

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