すべてのプロダクト
Search
ドキュメントセンター

:ListServerGroupServers

最終更新日:Aug 06, 2025

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

gwlb:ListServerGroupServers

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

タイプ

必須 / 任意

説明

ServerGroupId

string

任意

サーバーグループの ID です。

sgp-atstuj3rtoptyui****

ServerIds

array

任意

サーバー ID のリストです。

1 回の呼び出しで最大 200 個のサーバー ID を指定できます。

string

任意

サーバー ID です。

  • サーバーグループがインスタンスタイプの場合、このパラメーターは、ECS インスタンス、Elastic Network Interface (ENI)、または Elastic Container Instance (ECI) のリソース ID を指定します。

  • サーバーグループが IP タイプの場合、このパラメーターは IP アドレスを指定します。

i-bp67acfmxazb4p****

ServerIps

array

任意

サーバーの IP アドレスのリストです。

1 回の呼び出しで最大 200 個のサーバー IP アドレスを指定できます。

string

任意

サーバーの IP アドレスです。

192.168.xxx.xxx

NextToken

string

任意

次のリクエストで新しい結果ページを取得するために使用されるページネーショントークンです。有効な値:

  • NextToken が空の場合、次のページは存在しません。

  • NextToken の値が返された場合、その値は次のページを取得するために使用されるトークンです。

FFmyTO70tTpLG6I3FmYAXGKPd****

MaxResults

integer

任意

各ページに返すエントリの数です。

有効な値:1 ~ 1000。

デフォルト値:20。

20

Skip

integer

任意

スキップするエントリの数です。

1

レスポンスパラメーター

パラメーター

タイプ

説明

object

レスポンスのデータ構造です。

MaxResults

integer

1 ページあたりに返されるエントリの数です。

有効な値:1 ~ 1000。

20

NextToken

string

ページネーショントークンです。次のリクエストで新しい結果ページを取得するために使用できます。有効な値:

  • 最初のリクエスト、または次のページが存在しない場合は、このパラメーターを指定する必要はありません。

  • 次のページが存在する場合は、最後の API 呼び出しで返された NextToken 値に設定します。

FFmyTO70tTpLG6I3FmYAXGKPd****

RequestId

string

リクエスト ID です。

54B48E3D-DF70-471B-AA93-08E683A1B45

Servers

array<object>

バックエンドサーバーのリストです。

object

バックエンドサーバーです。

Port

integer

バックエンドサーバーが使用するポートです。有効な値:

  • 6081

6081

ServerGroupId

string

サーバーグループの ID です。

sgp-atstuj3rtoptyui****

ServerId

string

バックエンドサーバーの ID です。

i-bp67acfmxazb4p****

ServerIp

string

バックエンドサーバーの IP アドレスです。

192.168.xxx.xxx

ServerType

string

バックエンドサーバーのタイプです。有効な値:

  • Ecs:ECS インスタンス。

  • Eni:Elastic Network Interface (ENI)。

  • Eci:Elastic Container Instance (ECI)。

  • Ip:IP アドレス。

Ecs

Status

string

バックエンドサーバーのステータスです。有効な値:

  • Adding:バックエンドサーバーが追加されています。

  • Available:バックエンドサーバーは想定どおりに実行されています。

  • Draining:バックエンドサーバーへの接続がドレインされています。

  • Removing:バックエンドサーバーが削除されています。

  • Replacing:バックエンドサーバーが置き換えられています。

Available

TotalCount

integer

リスト内のエントリの数です。

1

成功レスポンス

JSONJSON

{
  "MaxResults": 20,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "Servers": [
    {
      "Port": 6081,
      "ServerGroupId": "sgp-atstuj3rtoptyui****",
      "ServerId": "i-bp67acfmxazb4p****",
      "ServerIp": "192.168.xxx.xxx",
      "ServerType": "Ecs",
      "Status": "Available"
    }
  ],
  "TotalCount": 1
}

エラーコード

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

変更履歴

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