すべてのプロダクト
Search

このプロダクト

    Server Load Balancer:ListServerGroups

    ドキュメントセンター

    Server Load Balancer:ListServerGroups

    最終更新日:Sep 02, 2026

    サーバーグループのリストを照会します。

    今すぐお試しください

    この 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。1 回のリクエストで最大 20 個のサーバーグループ ID を指定できます。

    sgp-atstuj3rtop****
    ServerGroupNames

    array

    任意

    サーバーグループの名前。最大 10 個の名前を指定できます。

    string

    任意

    サーバーグループの名前。1 回のリクエストで最大 10 個のサーバーグループ名を指定できます。

    Group3
    ResourceGroupId

    string

    任意

    リソースグループの ID。

    rg-atstuj3rtop****
    NextToken

    string

    任意

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

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

    • 次のクエリが存在する場合は、前の API 呼び出しで返された NextToken の値を設定します。

    FFmyTO70tTpLG6I3FmYAXG****
    MaxResults

    integer

    任意

    ページごとに返すエントリの最大値。有効な値: 1 ～ 100。デフォルト値: 20。

    20
    VpcId

    string

    任意

    VPC に接続されたインスタンスの ID。

    vpc-bp15zckdt37pq72zv****
    ServerGroupType

    string

    任意

    サーバーグループのタイプ。有効な値:

    • Instance: サーバータイプ。ECS、ENI、ECI インスタンスが含まれます。

    • Ip: IP アドレスタイプ。

    • Fc: Function Compute タイプ。

    • このパラメーターを空にすると、すべてのタイプのサーバーグループが照会されます。

    Instance
    Tag

    array<object>

    任意

    サーバーグループにバインドされているタグ。1 回のリクエストで最大 10 個のタグを指定できます。

    Instance

    object

    任意

    サーバーグループにバインドされているタグ。1 回のリクエストで最大 10 個のタグを指定できます。

    Key

    string

    任意

    タグキー。最大 10 個のタグキーを指定できます。

    タグキーの長さは最大 64 文字で、aliyun または acs: で始まることはできません。また、http:// または https:// を含めることはできません。

    Test
    Value

    string

    任意

    タグ値。最大 10 個のタグ値を指定できます。

    タグ値の長さは最大 128 文字で、aliyun または acs: で始まることはできません。また、http:// または https:// を含めることはできません。

    Test

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンス構造体。

    MaxResults

    integer

    ページネーションクエリにおける 1 ページあたりのエントリ数。

    50
    NextToken

    string

    次のクエリが存在するかどうかを示します。有効な値:

    • 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

    ヘルスチェックが正常であることを示す状態コードのリスト。

    string

    ヘルスチェックが正常であることを示す状態コード。

    • HealthCheckProtocol が HTTP または HTTPS にセットされている場合、HealthCheckCodes は http_2xx、http_3xx、http_4xx、または http_5xx にセットできます。複数の状態コードはコンマ (,) で区切ります。

    • 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

    連続する 2 回のヘルスチェックの間隔。単位: 秒。有効な値: 1 ～ 50。

    5
    HealthCheckMethod

    string

    ヘルスチェックのメソッド。有効な値:

    • GET: レスポンスボディが 8 KB を超える場合、切り捨てられますが、ヘルスチェックの結果には影響しません。

    • POST: gRPC リスナーのヘルスチェックでは、デフォルトで POST メソッドが使用されます。

    • HEAD: HTTP および HTTPS リスナーのヘルスチェックでは、デフォルトで HEAD メソッドが使用されます。

    説明

    このパラメーターは、HealthCheckProtocol が HTTP、HTTPS、または gRPC にセットされている場合にのみ効果が得られます。

    HEAD
    HealthCheckPath

    string

    ヘルスチェックの転送ルールのパス。

    説明

    このパラメーターは、HealthCheckProtocol が HTTP または HTTPS にセットされている場合にのみ効果が得られます。

    /test/index.html
    HealthCheckProtocol

    string

    ヘルスチェックのプロトコル。有効な値:

    • HTTP: HEAD または GET リクエストを送信してブラウザのアクセス動作をシミュレートし、サーバーアプリケーションが正常かどうかを確認します。

    • HTTPS: HEAD または GET リクエストを送信してブラウザのアクセス動作をシミュレートし、サーバーアプリケーションが正常かどうかを確認します。(データ暗号化が使用されるため、HTTP よりも安全です。)

    • TCP: SYN ハンドシェイクパケットを送信して、サーバーポートが稼働中かどうかを確認します。

    • 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

    関連付けられたインスタンスの ID。

    string

    関連付けられた負荷分散インスタンスの 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、ECI インスタンスを含みます。

    • 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 を挿入します。クライアントが初めてサーバーにアクセスすると、負荷分散によって HTTP または HTTPS 応答に Cookie (SERVERID) が挿入されます。次回クライアントがこの Cookie を使用してサーバーにアクセスすると、負荷分散によってリクエストは以前に記録されたバックエンドサーバーに転送されます。

    • Server: Cookie を書き換えます。負荷分散がユーザー定義の Cookie を検出すると、元の Cookie が書き換えられます。次回クライアントが新しい Cookie を使用してサーバーにアクセスすると、負荷分散によってリクエストは以前に記録されたバックエンドサーバーに転送されます。

    Insert
    VpcId

    string

    VPC インスタンスの ID。

    vpc-bp15zckdt37pq72zv****
    Tags

    array<object>

    サーバーグループにバインドされたタグのリスト。

    object

    サーバーグループにバインドされたタグのリスト。

    Key

    string

    タグキー。

    Test
    Value

    string

    タグ値。

    Test
    ConfigManagedEnabled

    boolean

    構成管理が有効かどうかを示します。有効な値:

    • true: 有効。

    • false: 無効。

    false
    UpstreamKeepaliveEnabled

    boolean

    バックエンドキープアライブが有効かどうかを示します。有効な値:

    • 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

    接続ドレインの構成。

    接続ドレインを有効にすると、バックエンドサーバーが削除された場合やヘルスチェックに失敗した場合に、負荷分散は既存の接続に対して指定された期間中、標準のデータ送信を継続させ、その後接続が中断されます。

    説明

    • Basic Edition インスタンスでは接続ドレインはサポートされていません。この特徴は Standard Edition および WAF 対応エディションインスタンスでのみサポートされています。

    • サーバータイプおよび IP タイプのサーバーグループでは接続ドレインがサポートされています。Function Compute タイプのサーバーグループではサポートされていません。

    ConnectionDrainEnabled

    boolean

    接続ドレインが有効かどうかを示します。

    • true: 有効。

    • false: 無効。

    false
    ConnectionDrainTimeout

    integer

    接続ドレインのタイムアウト期間。

    300
    SlowStartConfig

    object

    スロースタートの構成。

    スロースタートを有効にすると、サーバーグループに新しく追加されたバックエンドサーバーが指定された期間内にウォームアップされます。サーバーに転送されるリクエスト数は線形に増加します。

    説明

    • Basic Edition インスタンスではスロースタートはサポートされていません。この特徴は Standard Edition および WAF 対応エディションインスタンスでのみサポートされています。

    • サーバータイプおよび IP タイプのバックエンドサーバーグループではスロースタート構成がサポートされています。Function Compute バックエンドサーバーグループではサポートされていません。

    • スロースタートは、バックエンドのスケジューリングアルゴリズムが重み付き四捨五入である場合にのみ有効にできます。

    SlowStartEnabled

    boolean

    スロースタートが有効かどうかを示します。

    • true: 有効。

    • false: 無効。

    false
    SlowStartDuration

    integer

    スロースタートの持続時間。

    30
    CrossZoneEnabled

    boolean

    サーバーグループでクロスゾーン負荷分散が有効かどうかを示します。有効な値:

    • true: 有効 (デフォルト)。

    • false: 無効。

    true
    IpVersionAffinityMode

    string

    サーバーグループの IP バージョンアフィニティモード。

    Affinity
    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,
      "IpVersionAffinityMode": "Affinity"
    }
  ],
  "TotalCount": 1000
}

    エラーコード

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

    変更履歴

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