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

get

*ServerGroup

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ServerGroupIds	array	任意	サーバーグループ ID。
	string	任意	照会するサーバーグループの ID。各呼び出しで最大 20 個の ID を指定できます。	sgp-atstuj3rtop****
ServerGroupNames	array	任意	照会するサーバーグループの名前。最大 10 個のサーバーグループ名を指定できます。
	string	任意	照会するサーバーグループの名前。各呼び出しで最大 10 個のサーバーグループ名を指定できます。	Group3
ResourceGroupId	string	任意	サーバーグループが属するリソースグループの ID。	rg-atstuj3rtop****
NextToken	string	任意	次のリクエストで使用されるページネーショントークンで、結果の新しいページを取得します。有効な値：最初のリクエストでは、このパラメーターを指定する必要はありません。前のクエリから取得したトークンを NextToken の値として指定する必要があります。	FFmyTO70tTpLG6I3FmYAXG****
MaxResults	integer	任意	1 ページあたりのエントリ数。有効な値：1～100。デフォルト値：20。	20
VpcId	string	任意	Virtual Private Cloud (VPC) の ID。	vpc-bp15zckdt37pq72zv****
ServerGroupType	string	任意	サーバーグループのタイプ。有効な値： Instance：インスタンス。ECS インスタンス、ENI、Elastic Container Instance を含みます。 Ip：IP アドレス。 Fc：Function Compute	Instance
Tag	array<object>	任意	サーバーグループに追加されるタグ。各呼び出しで最大 10 個のタグを指定できます。	Instance
	object	任意	サーバーグループに追加されるタグ。各呼び出しで最大 10 個のタグを指定できます。
Key	string	任意	タグキー。最大 10 個のタグキーを指定できます。タグキーは最大 64 文字で、`http://` または `https://` を含めることはできません。`aliyun` または `acs:` で始めることはできません。	Test
Value	string	任意	タグ値。最大 10 個のタグ値を指定できます。タグ値は最大 128 文字で、`http://` または `https://` を含めることはできません。`aliyun` または `acs:` で始めることはできません。	Test

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
MaxResults	integer	1 ページあたりに返されるエントリ数。	50
NextToken	string	次のリクエストで使用されるページネーショントークンで、結果の新しいページを取得します。有効な値： NextToken が空の場合、次のページはありません。 NextToken が空でない場合、NextToken の値を次のリクエストで使用して、結果の新しいページを取得できます。	caeba0bbb2be03f8****
RequestId	string	リクエスト ID。	CEF72CEB-54B6-4AE8-B225-F876******
ServerGroups	array<object>	サーバーグループ。
	array<object>	サーバーグループ。
HealthCheckConfig	object	ヘルスチェックの構成。
HealthCheckConnectPort	integer	ヘルスチェックに使用されるバックエンドポート。有効な値：0～65535。値 0 は、バックエンドサーバーのポートがヘルスチェックに使用されることを示します。	80
HealthCheckEnabled	boolean	ヘルスチェック機能が有効になっているかどうかを示します。有効な値： true false	true
HealthCheckHost	string	ヘルスチェックに使用されるドメイン名。バックエンドサーバーの内部 IP (デフォルト)：バックエンドサーバーの内部 IP アドレスをヘルスチェックのドメイン名として使用します。カスタムドメイン名：ドメイン名を入力します。ドメイン名は 1～80 文字です。ドメイン名には、小文字、数字、ハイフン (-)、ピリオド (.) を使用できます。ドメイン名には少なくとも 1 つのピリオド (.) が含まれている必要がありますが、ピリオド (.) で開始または終了することはできません。ドメイン名の右端のドメインラベルには文字のみを含めることができ、数字やハイフン (-) を含めることはできません。ドメイン名はハイフン (-) で開始または終了することはできません。説明このパラメーターは、HealthCheckProtocol が HTTP、HTTPS、または gRPC に設定されている場合にのみ有効です。	www.example.com
HealthCheckCodes	array	正常なバックエンドサーバーを示す HTTP ステータスコード。
	string	正常なバックエンドサーバーを示す HTTP ステータスコード。 HealthCheckProtocol が HTTP または HTTPS に設定されている場合、HealthCheckCodes を http_2xx、http_3xx、http_4xx、http_5xx に設定できます。複数の HTTP ステータスコードはコンマ (,) で区切ります。 HealthCheckProtocol が gRPC に設定されている場合、HealthCheckCodes の有効な値は 0～99 です。値の範囲がサポートされています。最大 20 の値の範囲がサポートされています。複数の値の範囲はコンマ (,) で区切ります。説明このパラメーターは、HealthCheckProtocol が HTTP、HTTPS、または gRPC に設定されている場合にのみ有効です。	http_2xx
HealthCheckHttpVersion	string	ヘルスチェックに使用される HTTP バージョン。有効な値：HTTP1.0 および HTTP1.1。説明このパラメーターは、HealthCheckProtocol が HTTP または HTTPS に設定されている場合にのみ有効です。	HTTP1.1
HealthCheckInterval	integer	ヘルスチェックが実行される間隔。単位：秒。有効な値：1～50。	5
HealthCheckMethod	string	ヘルスチェックに使用される HTTP メソッド。有効な値： GET：応答の長さが 8 KB を超える場合、応答は切り捨てられます。ただし、ヘルスチェックの結果には影響しません。 POST：gRPC ヘルスチェックはデフォルトで POST メソッドを使用します。 HEAD：HTTP および HTTPS ヘルスチェックはデフォルトで HEAD メソッドを使用します。説明このパラメーターは、HealthCheckProtocol が HTTP、HTTPS、または gRPC に設定されている場合にのみ有効です。	HEAD
HealthCheckPath	string	ヘルスチェックに使用される URL。説明このパラメーターは、HealthCheckProtocol が HTTP または HTTPS に設定されている場合にのみ有効です。	/test/index.html
HealthCheckProtocol	string	ヘルスチェックに使用されるプロトコル。有効な値： HTTP：HTTP ヘルスチェックは、HEAD または GET リクエストを送信してバックエンドサーバーの可用性を調査することで、ブラウザの動作をシミュレートします。 HTTPS：HTTPS ヘルスチェックは、HEAD または GET リクエストを送信してバックエンドサーバーの可用性を調査することで、ブラウザの動作をシミュレートします。HTTPS は暗号化をサポートし、HTTP よりも高いセキュリティを提供します。 TCP：TCP ヘルスチェックは、TCP SYN パケットをバックエンドサーバーに送信して、バックエンドサーバーのポートに到達可能かどうかを確認します。 gRPC：gRPC ヘルスチェックは、POST または GET リクエストをバックエンドサーバーに送信して、バックエンドサーバーが正常であるかどうかを確認します。	HTTP
HealthCheckTimeout	integer	ヘルスチェック応答のタイムアウト期間。バックエンドサーバーが指定されたタイムアウト期間内に応答しない場合、バックエンドサーバーは異常と宣言されます。単位：秒。	3
HealthyThreshold	integer	異常なバックエンドサーバーが正常と宣言されるまでに連続してヘルスチェックに合格する必要がある回数。この場合、ヘルスステータスは fail から success に変更されます。	4
UnhealthyThreshold	integer	正常なバックエンドサーバーが異常と宣言されるまでに連続してヘルスチェックに失敗する必要がある回数。この場合、ヘルスステータスは success から fail に変更されます。	4
Protocol	string	バックエンドプロトコル。有効な値： HTTP：HTTPS、HTTP、または QUIC リスナーをバックエンドサーバーに関連付けることができます。 HTTPS：HTTPS リスナーをバックエンドサーバーに関連付けることができます。 GRPC：HTTPS および QUIC リスナーをバックエンドサーバーに関連付けることができます。	HTTP
RelatedLoadBalancerIds	array	サーバーグループに関連付けられている ALB インスタンスの ID。
	string	ALB インスタンスの ID。	alb-n5qw04uq8savfe****
ResourceGroupId	string	インスタンスが属するリソースグループの ID。	rg-atstuj3rtop****
Scheduler	string	スケジューリングアルゴリズム。有効な値： Wrr：重み付きラウンドロビン。重みが大きいバックエンドサーバーは、重みが小さいバックエンドサーバーよりも多くのリクエストを受信します。 Wlc：重み付き最小接続。リクエストは、各バックエンドサーバーの重みと負荷に基づいて分散されます。負荷とは、バックエンドサーバー上の接続数を指します。複数のバックエンドサーバーの重みが同じ場合、リクエストは接続数が最も少ないバックエンドサーバーに転送されます。 Sch：一貫性ハッシュ。同じハッシュ係数を持つリクエストは、同じバックエンドサーバーに分散されます。UchConfig パラメーターを指定しない場合、デフォルトで送信元 IP アドレスがハッシュ係数として使用されます。同じ IP アドレスからのリクエストは、同じバックエンドサーバーに分散されます。UchConfig パラメーターを指定した場合、URL 文字列がハッシュ係数として使用されます。同じ URL 文字列を持つリクエストは、同じバックエンドサーバーに分散されます。	Wrr
ServerGroupId	string	サーバーグループ ID。	sgp-cige6j****
ServerGroupName	string	サーバーグループ名。	Group3
ServerGroupStatus	string	サーバーグループのステータス。有効な値： Creating。 Available Configuring	Available
ServerGroupType	string	サーバーグループのタイプ。有効な値： Instance：インスタンス。ECS インスタンス、ENI、Elastic Container Instance を含みます。 Ip：IP アドレス。 Fc：Function Compute	Instance
StickySessionConfig	object	セッション維持の構成。
Cookie	string	サーバー用に構成された cookie。	B490B5EBF6F3CD402E515D22BCDA****
CookieTimeout	integer	cookie のタイムアウト期間。単位：秒。有効な値：1～86400。説明このパラメーターは、StickySessionEnabled が true に設定され、StickySessionType が Insert に設定されている場合にのみ有効です。	1000
StickySessionEnabled	boolean	セッション維持が有効になっているかどうかを示します。有効な値： true false	false
StickySessionType	string	cookie を処理するために使用されるメソッド。有効な値： insert：cookie を挿入します。クライアントが初めて ALB にアクセスすると、ALB は SERVERID cookie を HTTP または HTTPS 応答パケットに挿入します。この cookie を持つクライアントからの後続のリクエストは、最初のリクエストと同じバックエンドサーバーに転送されます。 Server：cookie を再書き込みします。ALB は、クライアントからのリクエストに含まれるカスタム cookie を再書き込みします。新しい cookie を持つクライアントからの後続のリクエストは、最初のリクエストと同じバックエンドサーバーに転送されます。	Insert
VpcId	string	ALB インスタンスが属する VPC の ID。	vpc-bp15zckdt37pq72zv****
Tags	array<object>	サーバーグループに追加されるタグ。
	object	サーバーグループに追加されるタグ。
Key	string	タグキー。	Test
Value	string	タグ値。	Test
ConfigManagedEnabled	boolean	構成管理が有効になっているかどうかを示します。有効な値： true false	false
UpstreamKeepaliveEnabled	boolean	TCP 持続的接続が有効になっているかどうかを示します。有効な値： true false	false
Ipv6Enabled	boolean	IPv6 がサポートされているかどうかを示します。有効な値： true false	false
ServerCount	integer	サーバーグループ内のバックエンドサーバーの数。	1
ServiceName	string	サーバーグループの名前。	test
UchConfig	object	URL に基づく一貫性ハッシュの構成。
Type	string	パラメータータイプ。有効な値：QueryString。	QueryString
Value	string	ハッシュ値。	abc
CreateTime	string	リソースが作成された時間。	2022-07-02T02:49:05Z
ConnectionDrainConfig	object	接続ドレインの構成。接続ドレインが有効になると、ALB はバックエンドサーバーが削除されたり異常と宣言された後も、一定期間データ転送を維持します。説明 Basic ALB インスタンスは接続ドレインをサポートしていません。Standard および WAF 対応 ALB インスタンスは接続ドレインをサポートしています。インスタンスタイプおよび IP タイプのサーバーグループは接続ドレインをサポートしています。Function Compute タイプのサーバーグループは接続ドレインをサポートしていません。
ConnectionDrainEnabled	boolean	接続ドレインが有効になっているかどうかを示します。有効な値： true false	false
ConnectionDrainTimeout	integer	接続ドレインのタイムアウト期間。	300
SlowStartConfig	object	スロースタートの構成。スロースタートが有効になると、ALB は新しく追加されたバックエンドサーバーにデータをプリフェッチします。バックエンドサーバーに分散されるリクエストは徐々に増加します。説明 Basic ALB インスタンスはスロースタートをサポートしていません。Standard および WAF 対応 ALB インスタンスはスロースタートをサポートしています。インスタンスタイプおよび IP タイプのサーバーグループはスロースタートをサポートしています。Function Compute タイプのサーバーグループはスロースタートをサポートしていません。スロースタートは、重み付きラウンドロビンスケジューリングアルゴリズムでのみサポートされます。
SlowStartEnabled	boolean	スロースタートが有効になっているかどうかを示します。有効な値： true false	false
SlowStartDuration	integer	スロースタートの期間。	30
CrossZoneEnabled	boolean	クロスゾーン負荷分散が有効になっているかどうかを示します。有効な値： true (デフォルト) false	true
TotalCount	integer	返されたエントリの総数。	1000

例

成功レスポンス

JSONJSON

{
  "MaxResults": 50,
  "NextToken": "caeba0bbb2be03f8****",
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876******",
  "ServerGroups": [
    {
      "HealthCheckConfig": {
        "HealthCheckConnectPort": 80,
        "HealthCheckEnabled": true,
        "HealthCheckHost": "www.example.com",
        "HealthCheckCodes": [
          "http_2xx"
        ],
        "HealthCheckHttpVersion": "HTTP1.1",
        "HealthCheckInterval": 5,
        "HealthCheckMethod": "HEAD",
        "HealthCheckPath": "/test/index.html",
        "HealthCheckProtocol": "HTTP",
        "HealthCheckTimeout": 3,
        "HealthyThreshold": 4,
        "UnhealthyThreshold": 4
      },
      "Protocol": "HTTP",
      "RelatedLoadBalancerIds": [
        "alb-n5qw04uq8savfe****"
      ],
      "ResourceGroupId": "rg-atstuj3rtop****",
      "Scheduler": "Wrr",
      "ServerGroupId": "sgp-cige6j****",
      "ServerGroupName": "Group3",
      "ServerGroupStatus": "Available",
      "ServerGroupType": "Instance",
      "StickySessionConfig": {
        "Cookie": "B490B5EBF6F3CD402E515D22BCDA****",
        "CookieTimeout": 1000,
        "StickySessionEnabled": false,
        "StickySessionType": "Insert"
      },
      "VpcId": "vpc-bp15zckdt37pq72zv****",
      "Tags": [
        {
          "Key": "Test",
          "Value": "Test"
        }
      ],
      "ConfigManagedEnabled": false,
      "UpstreamKeepaliveEnabled": false,
      "Ipv6Enabled": false,
      "ServerCount": 1,
      "ServiceName": "test",
      "UchConfig": {
        "Type": "QueryString",
        "Value": "abc"
      },
      "CreateTime": "2022-07-02T02:49:05Z",
      "ConnectionDrainConfig": {
        "ConnectionDrainEnabled": false,
        "ConnectionDrainTimeout": 300
      },
      "SlowStartConfig": {
        "SlowStartEnabled": false,
        "SlowStartDuration": 30
      },
      "CrossZoneEnabled": true
    }
  ],
  "TotalCount": 1000
}

エラーコード

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

変更履歴

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