すべてのプロダクト
Search

このプロダクト

    Server Load Balancer:DescribeLoadBalancers

    ドキュメントセンター

    Server Load Balancer:DescribeLoadBalancers

    最終更新日:Mar 02, 2026

    作成済みの 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    slb:DescribeLoadBalancers

    get

    *LoadBalancer

    acs:slb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    Classic Load Balancer (CLB) インスタンスのリージョン ID です。

    DescribeRegions 操作を呼び出してリージョン ID を照会できます。

    cn-hangzhou
    ServerId

    string

    任意

    CLB インスタンスに追加されたバックエンドサーバーの ID です。

    i-2zebcbq******
    AddressIPVersion

    string

    任意

    IP バージョン。値を ipv4 または ipv6 に設定します。

    ipv4
    LoadBalancerStatus

    string

    任意

    インスタンスの状態。有効な値：

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

    • active：インスタンスは実行中です。これは、インスタンス作成後のデフォルトの状態です。

    • locked：インスタンスはロックされています。インスタンスは有効期限が切れるとロック状態になります。この状態は 7 日間続きます。インスタンスに対する操作は実行できません。インスタンスはトラフィックを転送しませんが、IP アドレスやその他の構成は保持されます。

    active
    LoadBalancerId

    string

    任意

    CLB インスタンスの ID です。

    最大 10 個の ID をコンマ (,) で区切って指定できます。

    lb-bp1b6c719dfa****
    LoadBalancerName

    string

    任意

    CLB インスタンスの名前です。

    名前の長さは 1～80 文字である必要があります。先頭は英字または漢字である必要があります。英字、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を使用できます。

    最大 10 個の名前を指定できます。複数の名前はコンマ (,) で区切ります。

    test
    ServerIntranetAddress

    string

    任意

    追加されたバックエンドサーバーのプライベート IP アドレスです。

    複数の IP アドレスを指定できます。コンマ (,) で区切ります。

    10.XX.XX.102
    AddressType

    string

    任意

    CLB インスタンスのネットワークタイプ。有効な値：

    • internet：インターネット向け CLB インスタンス。システムはインスタンスにパブリック IP アドレスを割り当てます。インスタンスはインターネットからのリクエストを転送できます。

    • intranet：イントラネット向け CLB インスタンス。システムはインスタンスにプライベート IP アドレスを割り当てます。インスタンスは内部ネットワーク内でのみリクエストを転送できます。

    intranet
    InternetChargeType

    string

    任意

    インターネット向け CLB インスタンスの課金方法。有効な値：

    • paybybandwidth：帯域幅課金。

    • paybytraffic：トラフィック課金。

    paybytraffic
    VpcId

    string

    任意

    CLB インスタンスが属する VPC の ID です。

    vpc-bp1aevy8sof****
    VSwitchId

    string

    任意

    CLB インスタンスが属する vSwitch の ID です。

    vsw-bp12mw1f8k3****
    NetworkType

    string

    任意

    イントラネット向け CLB インスタンスのネットワークタイプ。有効な値：

    • vpc：VPC。

    • classic：クラシックネットワーク。

    vpc
    Address

    string

    任意

    CLB インスタンスのサービスアドレスです。

    192.168.XX.XX
    MasterZoneId

    string

    任意

    CLB インスタンスのプライマリゾーンの ID です。

    cn-hangzhou-b
    SlaveZoneId

    string

    任意

    CLB インスタンスのセカンダリゾーンの ID です。

    マルチゾーン機能は Finance Cloud ユーザーは利用できません。

    cn-hangzhou-d
    Tags

    string

    任意

    CLB インスタンスに追加されたタグです。値は、タグキーとタグ値で構成される JSON 辞書です。

    各リクエストで最大 10 個のタグを追加できます。

    [{"tagKey":"Key1","tagValue":"Value1"}]
    PayType

    string

    任意

    CLB インスタンスの課金方法。有効な値：

    • PayOnDemand：従量課金。

    PayOnDemand
    ResourceGroupId

    string

    任意

    リソースグループの ID です。

    rg-acfmxazb4p****
    PageNumber

    integer

    任意

    返すページのページ番号です。

    1
    PageSize

    integer

    任意

    各ページで返すエントリ数です。

    有効な値：1～100。

    説明

    PageSize を設定する場合は、PageNumber も設定する必要があります。

    50
    Tag

    array<object>

    任意

    タグのリストです。

    object

    任意

    タグのリストです。

    Key

    string

    任意

    タグ N のキー。N の有効な値：1～20。タグキーは空の文字列にできません。

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

    FinanceDept
    Value

    string

    任意

    タグ N の値。N の有効な値：1～20。タグ値は空の文字列にできます。 タグ値は最大 128 文字です。aliyun または acs: で始めることはできません。http:// または https:// を含めることはできません。

    FinanceJoshua

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID です。

    8B9DB03B-ED39-5DB8-9C9F-1ED5F548D61E
    PageNumber

    integer

    返されたページのページ番号です。

    1
    PageSize

    integer

    現在のページで返されたエントリ数です。

    50
    TotalCount

    integer

    フィルター条件に一致するインスタンスの総数です。

    1
    LoadBalancers

    object

    LoadBalancer

    array<object>

    CLB インスタンスのリストです。

    array<object>

    CLB インスタンスのリストです。

    VpcId

    string

    イントラネット向け CLB インスタンスがデプロイされている VPC の ID です。

    vpc-25dvzy9f8****
    CreateTimeStamp

    integer

    インスタンスが作成された日時を示すタイムスタンプです。

    1504147745000
    LoadBalancerId

    string

    CLB インスタンスの ID です。

    lb-bp1b6c719dfa****
    CreateTime

    string

    インスタンスが作成された時刻です。時刻のフォーマットは YYYY-MM-DDThh:mm:ssZ です。

    2021-12-02T02:49:05Z
    PayType

    string

    CLB インスタンスの課金方法。有効な値：

    • PayOnDemand：従量課金。

    PayOnDemand
    AddressType

    string

    インスタンスのネットワークタイプ。有効な値：

    • internet：インターネット向け CLB インスタンス。システムはインスタンスにパブリック IP アドレスを割り当てます。インスタンスはインターネットからのリクエストを転送できます。

    • intranet：イントラネット向け CLB インスタンス。システムはインスタンスにプライベート IP アドレスを割り当てます。インスタンスは内部ネットワーク内でのみリクエストを転送できます。

    intranet
    NetworkType

    string

    イントラネット向け CLB インスタンスのネットワークタイプ。有効な値：

    • vpc：VPC。

    • classic：クラシックネットワーク。

    vpc
    AddressIPVersion

    string

    IP バージョン。有効な値：ipv4 および ipv6。

    ipv4
    LoadBalancerName

    string

    CLB インスタンスの名前です。

    lb-bp1o94dp5i6ea****
    Bandwidth

    integer

    リスナーのピーク帯域幅です。単位：Mbit/s。

    -1
    Address

    string

    CLB インスタンスのサービスアドレスです。

    100.XX.XX.28
    SlaveZoneId

    string

    インスタンスのセカンダリゾーンの ID です。

    cn-hangzhou-d
    MasterZoneId

    string

    インスタンスのプライマリゾーンの ID です。

    cn-hangzhou-b
    InternetChargeTypeAlias

    string

    インターネット向け CLB インスタンスの課金方法。有効な値：

    • paybybandwidth：帯域幅課金。

    • paybytraffic：トラフィック課金

    paybybandwidth
    LoadBalancerSpec

    string

    CLB インスタンスの仕様です。

    説明

    トラフィック課金インスタンスには仕様がありません。デフォルト値 slb.lcu.elastic が返されます。

    slb.s1.small
    RegionId

    string

    CLB インスタンスのリージョン ID です。

    cn-hangzhou
    ModificationProtectionReason

    string

    設定変更保護が有効になっている理由です。理由は 1～80 文字である必要があります。先頭は英字または漢字である必要があります。英字、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を使用できます。

    説明

    このパラメーターは、ModificationProtectionStatus が ConsoleProtection に設定されている場合にのみ有効です。

    ManagedInstance
    ModificationProtectionStatus

    string

    設定変更保護のステータス：

    • NonProtection：設定変更保護は無効です。モードを無効にすると、ModificationProtectionReason の値はクリアされます。

    • ConsoleProtection：設定変更保護は有効です。

    説明

    値が ConsoleProtection の場合、設定変更保護が有効になります。CLB コンソールでインスタンスの構成を変更することはできません。ただし、API 操作を呼び出してインスタンスの構成を変更することはできます。

    ConsoleProtection
    VSwitchId

    string

    イントラネット向け CLB インスタンスがデプロイされている VPC 内の vSwitch の ID です。

    vsw-255ecr****
    LoadBalancerStatus

    string

    CLB インスタンスの状態。有効な値：

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

    • active：インスタンスは実行中です。これは、インスタンス作成後のデフォルトの状態です。

    • locked：インスタンスはロックされています。

    active
    ResourceGroupId

    string

    リソースグループの ID です。

    rg-atstuj3r****
    InternetChargeType

    string

    インターネット向けインスタンスの課金方法。有効な値：

    • 3：帯域幅課金。

    • 4：トラフィック課金。

    3
    DeleteProtection

    string

    CLB インスタンスで削除保護が有効になっているかどうかを示します。有効な値：

    • on：有効。

    • off：無効。

    off
    RegionIdAlias

    string

    CLB インスタンスがデプロイされているリージョンの名前です。

    cn-hangzhou
    Tags

    object

    Tag

    array<object>

    タグのリスト

    object

    タグのリスト

    TagValue

    string

    タグ値です。

    testvalue
    TagKey

    string

    タグキーです。

    testkey

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "8B9DB03B-ED39-5DB8-9C9F-1ED5F548D61E",
  "PageNumber": 1,
  "PageSize": 50,
  "TotalCount": 1,
  "LoadBalancers": {
    "LoadBalancer": [
      {
        "VpcId": "vpc-25dvzy9f8****",
        "CreateTimeStamp": 1504147745000,
        "LoadBalancerId": "lb-bp1b6c719dfa****",
        "CreateTime": "2021-12-02T02:49:05Z",
        "PayType": "PayOnDemand",
        "AddressType": "intranet",
        "NetworkType": "vpc",
        "AddressIPVersion": "ipv4",
        "LoadBalancerName": "lb-bp1o94dp5i6ea****",
        "Bandwidth": -1,
        "Address": "100.XX.XX.28",
        "SlaveZoneId": "cn-hangzhou-d",
        "MasterZoneId": "cn-hangzhou-b",
        "InternetChargeTypeAlias": "paybybandwidth",
        "LoadBalancerSpec": "slb.s1.small",
        "RegionId": "cn-hangzhou",
        "ModificationProtectionReason": "ManagedInstance",
        "ModificationProtectionStatus": "ConsoleProtection",
        "VSwitchId": "vsw-255ecr****",
        "LoadBalancerStatus": "active",
        "ResourceGroupId": "rg-atstuj3r****",
        "InternetChargeType": "3",
        "DeleteProtection": "off",
        "RegionIdAlias": "cn-hangzhou",
        "Tags": {
          "Tag": [
            {
              "TagValue": "testvalue",
              "TagKey": "testkey"
            }
          ]
        }
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidTag The specified tags is invalid.
    400 TooManyResult fuzzy query retrieve too many instances.
    400 LocationServiceTimeout Location service connection timeout. Please try again later.
    403 UnauthorizedRegion The specified region of is not authorized.

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

    変更履歴

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