ListServerGroups API でタイプと ID で GWLB サーバーグループをクエリ - SLB

サーバーグループの一覧を取得します。

今すぐお試しください

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

get

ServerGroup

acs:gwlb:{#regionId}:{#accountId}:servergroup/*

ServerGroup

acs:gwlb:{#regionId}:{#accountId}:servergroup/{#ServerGroupId}

VPC

acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ServerGroupIds	array	任意	サーバーグループの ID。最大 20 個まで指定できます。
	string	任意	サーバーグループの ID。	sgp-atstuj3rtoptyui****
ServerGroupNames	array	任意	サーバーグループの名前。最大 20 個まで指定できます。
	string	任意	サーバーグループの名前。	testServerGroupName
ServerGroupType	string	任意	サーバーグループのタイプ。有効な値は以下のとおりです。 Instance：インスタンスベースのサーバーグループ。このグループには、ECS（Elastic Compute Service）、ENI（Elastic Network Interface）、および ECI（Elastic Container Instance）のバックエンドサーバーを追加できます。 Ip：IP アドレスベースのサーバーグループ。このグループには、IP アドレスを指定してバックエンドサーバーを追加できます。	Instance
ResourceGroupId	string	任意	リソースグループの ID。	rg-atstuj3rtop****
Tag	array<object>	任意	サーバーグループをフィルターするためのタグ。最大 20 個まで指定できます。
	object	任意	タグ。
Key	string	任意	タグのキー。長さは 1～128 文字で、`aliyun` や `acs:` で始まらず、`http://` や `https://` を含まない必要があります。	testTagKey
Value	string	任意	タグの値。長さは 1～256 文字で、`http://` や `https://` を含まない必要があります。	testTagValue
VpcId	string	任意	仮想プライベートクラウド (VPC) の ID。	vpc-bp15zckdt37pq72zv****
NextToken	string	任意	次のクエリに使用するトークン。有効な値は以下のとおりです。 NextToken パラメーターが空の場合、次のクエリは送信されません。 NextToken パラメーターに値が返された場合、その値が次のクエリに使用されるトークンとなります。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	任意	1 ページあたりに返すエントリー数。有効な値：1～1000。デフォルト値：20。	20
Skip	integer	任意	結果を返す前にスキップするエントリー数。	1

レスポンスフィールド

フィールド	型	説明	例
	object	応答データ。
MaxResults	integer	1 ページあたりのエントリー数。有効な値：1～1000。	20
NextToken	string	次のクエリに使用するトークン。 `NextToken` が空の場合、次のクエリは送信されません。 `NextToken` に値が返された場合、その値が次のクエリの開始位置を決定するトークンとなります。	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	リクエスト ID。	54B48E3D-DF70-471B-AA93-08E683A1B45
ServerGroups	array<object>	バックエンドサーバーグループのリスト。
	array<object>	バックエンドサーバーグループ。
ConnectionDrainConfig	object	接続ドレインの構成。
ConnectionDrainEnabled	boolean	接続ドレインが有効かどうかを示します。有効な値は以下のとおりです。 true：有効 false：無効	false
ConnectionDrainTimeout	integer	接続ドレインのタイムアウト期間。単位：秒。有効な値：1～3600。	300
CreateTime	string	リソースが作成された時刻。時刻は UTC 表記で、`yyyy-MM-ddTHH:mm:ssZ` 形式で表示されます。	2024-08-05T18:24:07Z
HealthCheckConfig	object	ヘルスチェックの構成。
HealthCheckConnectPort	integer	バックエンドサーバーに対するヘルスチェックに使用するポート。有効な値：1～65535。	80
HealthCheckConnectTimeout	integer	ヘルスチェック応答の最大タイムアウト期間。単位：秒。有効な値：1～300。	5
HealthCheckDomain	string	ヘルスチェックに使用するドメイン名。有効な値は以下のとおりです。 $SERVER_IP：バックエンドサーバーのプライベート IP アドレス。 domain：指定したドメイン名。ドメイン名は 1～80 文字で、小文字、数字、ハイフン (-)、ピリオド (.) を含めることができます。説明このパラメーターは、`HealthCheckProtocol` が `HTTP` に設定されている場合のみ有効です。	$SERVER_IP
HealthCheckEnabled	boolean	ヘルスチェックが有効かどうかを示します。有効な値は以下のとおりです。 true：有効 false：無効	true
HealthCheckHttpCode	array	HTTP ステータスコードのリスト。
	string	HTTP ステータスコード。複数の HTTP ステータスコードはカンマ (,) で区切ります。有効な値： http_2xx http_3xx http_4xx http_5xx デフォルト値：http_2xx。説明このパラメーターは、`HealthCheckProtocol` が `HTTP` に設定されている場合のみ有効です。	http_2xx
HealthCheckInterval	integer	ヘルスチェックを実行する間隔。単位：秒。有効な値：1～50。	10
HealthCheckPath	string	ヘルスチェックに使用するパス。パスは 1～80 文字で、英字、数字、および以下の特殊文字 (`- / . % ? # &`) を含めることができます。先頭はスラッシュ (/) で始める必要があります。説明このパラメーターは、`HealthCheckProtocol` が `HTTP` に設定されている場合のみ有効です。	/test/index.html
HealthCheckProtocol	string	ヘルスチェックに使用するプロトコル。有効な値は以下のとおりです。 TCP：システムは SYN パケットをサーバーに送信し、ポートへの到達可能性を確認します。 HTTP：システムは GET リクエストをサーバーに送信し、サーバーアプリケーションの健全性を確認します。	TCP
HealthyThreshold	integer	バックエンドサーバーを「健全」（「不健全」から「健全」へ）と宣言する前に、連続して成功するヘルスチェックの回数。有効な値：2～10。	2
UnhealthyThreshold	integer	バックエンドサーバーを「不健全」（「健全」から「不健全」へ）と宣言する前に、連続して失敗するヘルスチェックの回数。有効な値：2～10。	2
HealthCheckReq	string
HealthCheckExp	string
Protocol	string	バックエンドプロトコル。有効な値： GENEVE	GENEVE
RelatedLoadBalancerIds	array	関連付けられた GWLB インスタンスの ID。
	string	関連付けられた GWLB インスタンスの ID。	gwlb-cp6prgqy40hols****
ResourceGroupId	string	リソースグループの ID。	rg-atstuj3rtop****
Scheduler	string	スケジューリングアルゴリズム。有効な値は以下のとおりです。 5TCH（5 次元ルール一貫ハッシュ）：送信元 IP アドレス、宛先 IP アドレス、送信元ポート、宛先ポート、およびプロトコルに基づいて 5 次元ルールハッシュを計算します。同じ 5 次元ルールを持つパケットは、同じバックエンドサーバーに転送されます。 3TCH（3 次元ルール一貫ハッシュ）：送信元 IP アドレス、宛先 IP アドレス、およびプロトコルに基づいて 3 次元ルールハッシュを計算します。同じ 3 次元ルールを持つパケットは、同じバックエンドサーバーに転送されます。 2TCH（2 次元ルール一貫ハッシュ）：送信元 IP アドレスおよび宛先 IP アドレスに基づいて 2 次元ルールハッシュを計算します。同じ 2 次元ルールを持つパケットは、同じバックエンドサーバーに転送されます。	5TCH
ServerCount	integer	バックエンドサーバーの数。	2
ServerGroupId	string	サーバーグループの ID。	sgp-atstuj3rtoptyui****
ServerGroupName	string	サーバーグループの名前。	testServerGroupName
ServerGroupStatus	string	サーバーグループのステータス。有効な値は以下のとおりです。 Creating Available Configuring	Available
ServerGroupType	string	サーバーグループのタイプ。有効な値は以下のとおりです。 Instance：ECS、ENI、ECI の各タイプのサーバーを追加できます。 Ip：IP アドレスを指定してサーバーを追加できます。	Instance
ServerFailoverMode	string	サーバーが「不健全」と判定された際に既存の接続を処理する方法。有効な値は以下のとおりです。 NoRebalance：既存の接続は再バランス化されません。 Rebalance：既存の接続は再バランス化されます。	NoRebalance
Tags	array<object>	タグのリスト。
	object	タグ。
Key	string	タグキー。タグキーは空文字列にできません。長さは最大 128 文字で、`aliyun` や `acs:` で始まらず、`http://` や `https://` を含まない必要があります。	testTagKey
Value	string	タグ値。タグ値は最大 256 文字で、`http://` や `https://` を含まない必要があります。	testTagValue
VpcId	string	仮想プライベートクラウド (VPC) の ID。	vpc-bp15zckdt37pq72zv****
TotalCount	integer	返されたエントリーの合計数。	1

例

成功レスポンス

JSONJSON

{
  "MaxResults": 20,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "ServerGroups": [
    {
      "ConnectionDrainConfig": {
        "ConnectionDrainEnabled": false,
        "ConnectionDrainTimeout": 300
      },
      "CreateTime": "2024-08-05T18:24:07Z",
      "HealthCheckConfig": {
        "HealthCheckConnectPort": 80,
        "HealthCheckConnectTimeout": 5,
        "HealthCheckDomain": "$SERVER_IP",
        "HealthCheckEnabled": true,
        "HealthCheckHttpCode": [
          "http_2xx"
        ],
        "HealthCheckInterval": 10,
        "HealthCheckPath": "/test/index.html",
        "HealthCheckProtocol": "TCP",
        "HealthyThreshold": 2,
        "UnhealthyThreshold": 2,
        "HealthCheckReq": "",
        "HealthCheckExp": ""
      },
      "Protocol": "GENEVE",
      "RelatedLoadBalancerIds": [
        "gwlb-cp6prgqy40hols****"
      ],
      "ResourceGroupId": "rg-atstuj3rtop****",
      "Scheduler": "5TCH",
      "ServerCount": 2,
      "ServerGroupId": "sgp-atstuj3rtoptyui****",
      "ServerGroupName": "testServerGroupName",
      "ServerGroupStatus": "Available",
      "ServerGroupType": "Instance",
      "ServerFailoverMode": "NoRebalance",
      "Tags": [
        {
          "Key": "testTagKey",
          "Value": "testTagValue"
        }
      ],
      "VpcId": "vpc-bp15zckdt37pq72zv****"
    }
  ],
  "TotalCount": 1
}

エラーコード

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

変更履歴

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