すべてのプロダクト
Search

このプロダクト

    :ListLoadBalancers

    ドキュメントセンター

    :ListLoadBalancers

    最終更新日:Dec 02, 2025

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

    list

    LoadBalancer

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

    LoadBalancer

    acs:gwlb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

    VPC

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ZoneIds

    array

    任意

    ゾーン ID。一度に最大 20 個のゾーン ID をクエリできます。

    string

    任意

    ゾーン ID。

    cn-beijing-h
    VpcIds

    array

    任意

    Virtual Private Cloud (VPC) ID。一度に最大 20 個の VPC ID をクエリできます。

    string

    任意

    VPC ID。

    vpc-bp1xuejaht4o7yhh2****
    AddressIpVersion

    string

    任意

    IP バージョン。有効値：

    • Ipv4：IPv4。

    列挙値:

    • IPv4 :

      IPv4

    • DualStack :

      デュアルスタック

    Ipv4
    LoadBalancerStatus

    string

    任意

    GWLB インスタンスのステータス。有効値：

    • Active：インスタンスは実行中です。

    • Inactive：インスタンスは停止しています。この状態では、インスタンスのリスナーはトラフィックを転送しません。

    • Provisioning：インスタンスは作成中です。

    • Configuring：インスタンスは変更中です。

    Active
    LoadBalancerBusinessStatus

    string

    任意

    GWLB インスタンスのビジネスステータス。有効値：

    • Normal：インスタンスは正常に実行されています。

    • FinancialLocked：インスタンスは支払い延滞によりロックされています。

    Normal
    LoadBalancerNames

    array

    任意

    GWLB インスタンスの名前。一度に最大 20 個のインスタンス名をクエリできます。

    string

    任意

    GWLB インスタンスの名前。

    testGwlbName
    ResourceGroupId

    string

    任意

    リソースグループの ID。

    rg-aek2htf5qsyrn****
    LoadBalancerIds

    array

    任意

    GWLB インスタンスの ID。一度に最大 20 個のインスタンスをクエリできます。

    string

    任意

    GWLB インスタンスの ID。

    gwlb-cp6prgqy40hols****
    TrafficMode

    string

    任意

    トラフィックモード。有効値：

    • LoadBalance：負荷分散モード。

    • ByPass：バイパスモード。

    LoadBalance
    Tag

    array<object>

    任意

    タグ。各呼び出しで最大 20 個のタグを指定できます。

    object

    任意

    タグ。

    Key

    string

    任意

    タグキー。タグキーは空の文字列にできません。

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

    testTagKey
    Value

    string

    任意

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

    testTagValue
    NextToken

    string

    任意

    次のページの結果を取得するために使用されるトークン。有効値：

    • NextToken が空の場合、次のクエリは送信されません。

    • NextToken の値が返された場合、その値が次のクエリに使用されるトークンです。

    WyJyb290IiwibiIsIm4iLDEsMCwxNjg1MDY1NTgyNzYwLCI2NDcwMGY2ZTc2Zjc0MWFiZGEyZjQyNzc4ZDk2MmJkOTk3ZGZmM2Nm****
    MaxResults

    integer

    任意

    各ページで返すエントリ数。有効値：1～1000。デフォルト値：20。

    20
    Skip

    integer

    任意

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

    1

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    LoadBalancers

    array<object>

    GWLB インスタンスのリスト。

    array<object>

    GWLB インスタンス。

    AddressIpVersion

    string

    IP バージョン。有効値：

    • IPv4：IPv4。

    IPv4
    CreateTime

    string

    リソースが作成された時刻。時刻は UTC で、yyyy-MM-ddTHH:mm:ssZ 形式に従います。

    2024-08-05T18:24:07Z
    LoadBalancerBusinessStatus

    string

    GWLB インスタンスのビジネスステータス。有効値：

    • Normal：インスタンスは正常に実行されています。

    • FinancialLocked：インスタンスは支払い延滞によりロックされています。

    Normal
    LoadBalancerId

    string

    GWLB インスタンスの ID。

    gwlb-9njtjmqt7zfcqm****
    LoadBalancerName

    string

    GWLB インスタンスの名前。

    名前は 2～128 文字の長さで、英字または漢字で始まり、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を含めることができます。

    testGwlbName
    LoadBalancerStatus

    string

    GWLB インスタンスのステータス。有効値：

    • Active：インスタンスは実行中です。

    • Inactive：インスタンスは停止しています。この状態では、インスタンスのリスナーはトラフィックを転送しません。

    • Provisioning：インスタンスは作成中です。

    • Configuring：インスタンスは変更中です。

    Active
    ResourceGroupId

    string

    リソースグループの ID。

    rg-aek26jasguy****
    Tags

    array<object>

    タグ。

    object

    タグ。

    Key

    string

    タグキー。タグキーは空の文字列にできません。

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

    testTagKey
    Value

    string

    タグ値。タグ値は空の文字列にできます。

    タグ値の長さは最大 128 文字です。英字または漢字で始まり、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を含めることができます。値は `aliyun` または `acs:` で始めることはできず、`http://` または `https://` を含めることはできません。

    testTagValue
    VpcId

    string

    VPC の ID。

    vpc-uf6eg0vndlsa84n7r****
    ZoneMappings

    array<object>

    ゾーンと vSwitch のマッピング。少なくとも 1 つのゾーンを追加する必要があります。最大 20 個のゾーンを追加できます。現在のリージョンが 2 つ以上のゾーンをサポートしている場合は、少なくとも 2 つのゾーンを追加してください。

    array<object>

    ゾーンと vSwitch のマッピング。

    LoadBalancerAddresses

    array<object>

    GWLB インスタンスアドレスのリスト。

    object

    GWLB インスタンスアドレス。

    EniId

    string

    Elastic Network Interface (ENI) の ID。

    eni-bp17qv9zbzyqy629****
    PrivateIpv4Address

    string

    プライベート IPv4 アドレス。

    192.168.XX.XX
    VSwitchId

    string

    ゾーン内の vSwitch。各ゾーンはデフォルトで 1 つの vSwitch と 1 つのサブネットを使用します。

    vsw-2zemule5dz7okwqfv****
    ZoneId

    string

    ゾーン ID。ゾーン ID を取得するには、DescribeZones 操作を呼び出します。

    cn-hangzhou-g
    MaxResults

    integer

    ページごとに返されるエントリ数。有効値：1～1000。デフォルト値：20。

    20
    NextToken

    string

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

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

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

    CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAIldD2UAAAAACjMDLgAAADFTNzMyZDMwMzAzMDY5NzQzNDM0NmI3NzM2NjUzNzc4NzM2YTc0NjYzOTYz****
    RequestId

    string

    リクエスト ID。

    378A80E9-4262-5D8E-8D62-0969E52D7358
    TotalCount

    integer

    返されたエントリの総数。

    100

    例

    成功レスポンス

    JSONJSON

    {
  "LoadBalancers": [
    {
      "AddressIpVersion": "IPv4",
      "CreateTime": "2024-08-05T18:24:07Z",
      "LoadBalancerBusinessStatus": "Normal",
      "LoadBalancerId": "gwlb-9njtjmqt7zfcqm****",
      "LoadBalancerName": "testGwlbName",
      "LoadBalancerStatus": "Active",
      "ResourceGroupId": "rg-aek26jasguy****",
      "Tags": [
        {
          "Key": "testTagKey",
          "Value": "testTagValue"
        }
      ],
      "VpcId": "vpc-uf6eg0vndlsa84n7r****",
      "ZoneMappings": [
        {
          "LoadBalancerAddresses": [
            {
              "EniId": "eni-bp17qv9zbzyqy629****",
              "PrivateIpv4Address": "192.168.XX.XX"
            }
          ],
          "VSwitchId": "vsw-2zemule5dz7okwqfv****",
          "ZoneId": "cn-hangzhou-g"
        }
      ]
    }
  ],
  "MaxResults": 20,
  "NextToken": "CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAIldD2UAAAAACjMDLgAAADFTNzMyZDMwMzAzMDY5NzQzNDM0NmI3NzM2NjUzNzc4NzM2YTc0NjYzOTYz****",
  "RequestId": "378A80E9-4262-5D8E-8D62-0969E52D7358",
  "TotalCount": 100
}

    エラーコード

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

    変更履歴

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