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

Gateway Load Balancer (GWLB) インスタンスのサーバーグループをクエリします。

今すぐお試しください

この 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 個のサーバーグループ ID を指定できます。
	string	任意	サーバーグループ ID。	sgp-atstuj3rtoptyui****
ServerGroupNames	array	任意	サーバーグループ名。各呼び出しで最大 20 個のサーバーグループ名を指定できます。
	string	任意	サーバーグループ名。	testServerGroupName
ServerGroupType	string	任意	サーバーグループのタイプ。有効な値： Instance：Ecs、Eni、または Eci タイプのリソースを指定できます。 Ip：IP アドレスを指定してサーバーを追加できます。	Instance
ResourceGroupId	string	任意	インスタンスが属するリソースグループの ID。	rg-atstuj3rtop****
Tag	array<object>	任意	タグキー。各呼び出しで最大 20 個のタグを指定できます。
	object	任意	タグ。
Key	string	任意	タグキー。タグキーは空の文字列にできません。タグキーは最大 128 文字で、`acs:` または `aliyun` で始めることはできません。タグキーに `http://` または `https://` を含めることはできません。	testTagKey
Value	string	任意	タグ値。タグ値は最大 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	リソースが作成された時刻。時刻は ISO 8601 標準に準拠し、yyyy-MM-ddTHH:mm:ssZ 形式で表されます。時刻は UTC で表示されます。	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	ヘルスチェックに使用される URL。 URL は 1～80 文字で、文字、数字、および次の特殊文字を含めることができます：`- / . % ? # &` URL はスラッシュ (/) で始まる必要があります。説明このパラメーターは、HealthCheckProtocol を HTTP に設定した場合にのみ有効です。	/test/index.html
HealthCheckProtocol	string	ヘルスチェックに使用されるプロトコル。有効な値： TCP：TCP ヘルスチェックは、TCP SYN パケットをバックエンドサーバーに送信して、バックエンドサーバーのポートに到達可能かどうかを確認します。 HTTP：HTTP ヘルスチェックは、HEAD または GET リクエストをインスタンスに送信することで、Web ブラウザーを使用してリソースにアクセスするプロセスをシミュレートします。これらのリクエストは、インスタンスが正常であるかどうかを確認するために使用されます。	TCP
HealthyThreshold	integer	異常なバックエンドサーバーが正常と判断されるまでに連続してヘルスチェックに合格する必要がある回数。この場合、ヘルスステータスは fail から success に変わります。有効な値：2～10。	2
UnhealthyThreshold	integer	正常なバックエンドサーバーが異常と判断されるまでに連続してヘルスチェックに失敗する必要がある回数。この場合、ヘルスステータスは success から fail に変わります。有効な値：2～10。	2
Protocol	string	バックエンドプロトコル。有効な値： GENEVE。	GENEVE
RelatedLoadBalancerIds	array	サーバーグループに関連付けられている GWLB インスタンスの ID。
	string	サーバーグループに関連付けられている GWLB インスタンスの ID。	gwlb-cp6prgqy40hols****
ResourceGroupId	string	リソースグループ ID。	rg-atstuj3rtop****
Scheduler	string	スケジューリングアルゴリズム。有効な値： 5TCH：送信元 IP アドレス、宛先 IP アドレス、送信元ポート、プロトコル、宛先ポートの要素に基づく一貫性ハッシュを示します。前述の要素に基づく同じ情報を含むリクエストは、同じバックエンドサーバーに転送されます。 3TCH：送信元 IP アドレス、宛先 IP アドレス、プロトコルの要素に基づく一貫性ハッシュを示します。前述の要素に基づく同じ情報を含むリクエストは、同じバックエンドサーバーに転送されます。 2TCH：送信元 IP アドレスと宛先 IP アドレスの要素に基づく一貫性ハッシュを示します。前述の要素に基づく同じ情報を含むリクエストは、同じバックエンドサーバーに転送されます。	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	バックエンドサーバーが期待どおりに実行されていない場合に、GWLB が既存の接続を介してリクエストをどのように処理するかを指定します。有効な値： NoRebalance：GWLB は、既存の接続を介して異常なバックエンドサーバーにリクエストを転送し続けます。 Rebalance：GWLB は、既存の接続を介して残りの正常なバックエンドサーバーにリクエストを転送します。	NoRebalance
Tags	array<object>	タグ。
	object	タグ。
Key	string	タグキー。タグキーは空の文字列にできません。タグキーは最大 128 文字で、`acs:` または `aliyun` で始めることはできません。タグキーに `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
      },
      "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
}

エラーコード

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

変更履歴

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