すべてのプロダクト
Search

このプロダクト

    ENS:DescribeLoadBalancerTCPListenerAttribute

    ドキュメントセンター

    ENS:DescribeLoadBalancerTCPListenerAttribute

    最終更新日:May 07, 2026

    DescribeLoadBalancerTCPListenerAttribute 操作を呼び出して、TCP リスナーの構成を照会します。

    操作説明

    • API 呼び出しレート：1 秒あたり 100 回。

    • ユーザーごとの呼び出しレート：1 秒あたり 10 回。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    ens:DescribeLoadBalancerTCPListenerAttribute

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ListenerPort

    integer

    必須

    リスナーポート。有効値：1 ～ 65535。

    80
    LoadBalancerId

    string

    必須

    ロードバランサーインスタンスの ID。

    lb-5snthcyu1x10g7tywj7iu****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンススキーマ。

    RequestId

    string

    リクエスト ID。

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    ListenerPort

    integer

    ロードバランサーインスタンスが使用するフロントエンドポート。

    80
    Status

    string

    リスナーのステータス。有効値：

    • Running：リスナーは実行中です。

    • Stopped：リスナーは停止しています。

    • Starting：リスナーを起動中です。

    • Configuring：リスナーを構成中です。

    • Stopping：リスナーを停止中です。

    Stopped
    Bandwidth

    integer

    ロードバランサーのピーク帯域幅。デフォルト値は -1 で、帯域幅が無制限であることを示します。

    -1
    Scheduler

    string

    スケジューリングアルゴリズム。有効値：

    • wrr：重み付きラウンドロビン。重みが高いバックエンドサーバーほど多くのリクエストを受け取ります。

    • wlc：重み付き最小接続数。重みに加えて、各バックエンドサーバーのアクティブ接続数も考慮します。複数のバックエンドサーバーの重みが同じ場合、アクティブ接続数が最も少ないバックエンドサーバーが選択されます。

    • rr：ラウンドロビン。システムはバックエンドサーバーに順番にリクエストを分散します。

    • sch：送信元 IP ハッシュ。同じ送信元 IP アドレスからのリクエストは、常に同じバックエンドサーバーにルーティングされます。

    • tch：4 タプルハッシュ。同じ 4 タプル（送信元 IP アドレス、宛先 IP アドレス、送信元ポート、宛先ポート）を共有するリクエストは、同じバックエンドサーバーにルーティングされます。

    wrr
    PersistenceTimeout

    integer

    セッション維持タイムアウト。

    • デフォルト値：0。0 はセッション維持が無効であることを示します。

    • 有効値：0 ～ 3600。

    • 単位：秒。

    0
    EstablishedTimeout

    integer

    接続タイムアウト。有効値：10 ～ 900。単位：秒。

    500
    HealthCheck

    string

    ヘルスチェックを有効にするかどうかを指定します。有効値：

    • on：有効

    • off：無効

    on
    HealthyThreshold

    integer

    バックエンドサーバーのヘルスステータスを fail（異常）から success（正常）に変更するために必要な、連続した成功したヘルスチェックの回数。有効値：2 ～ 10。

    説明

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

    4
    UnhealthyThreshold

    integer

    バックエンドサーバーのヘルスステータスを success（正常）から fail（異常）に変更するために必要な、連続した失敗したヘルスチェックの回数。有効値：2 ～ 10。

    説明

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

    4
    HealthCheckConnectTimeout

    integer

    ヘルスチェックの応答タイムアウト。バックエンド ENS インスタンスがこのタイムアウト期間内に応答しない場合、ヘルスチェックは失敗します。

    • デフォルト値：5。

    • 有効値：1 ～ 300。

    • 単位：秒。

    説明

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

    • この値が HealthCheckInterval の値より小さい場合、代わりに HealthCheckInterval の値がタイムアウト期間として使用されます。

    100
    HealthCheckInterval

    integer

    ヘルスチェックの間隔。有効値：1 ～ 50。単位：秒。

    5
    Description

    string

    リスナーの説明。

    example
    HealthCheckHttpCode

    string

    ヘルスチェックが成功したとみなされる HTTP ステータスコード。有効値：

    • http_2xx（デフォルト）

    • http_3xx

    • http_4xx

    • http_5xx

    説明

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

    http_2xx
    HealthCheckDomain

    string

    ヘルスチェックに使用するドメイン名。

    説明

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

    example.com
    HealthCheckURI

    string

    ヘルスチェックに使用する URI。長さ：1 ～ 80 文字。

    説明

    • URI は / で始まる必要がありますが、/ のみで構成することはできません。

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

    /example/index.html
    HealthCheckType

    string

    ヘルスチェックタイプ。有効値：

    • tcp（デフォルト）

    • http

    tcp
    BackendServerPort

    integer

    バックエンドサーバーが使用するポート。有効値：1 ～ 65535。

    8080
    HealthCheckConnectPort

    integer

    ヘルスチェックに使用するポート。有効値：1 ～ 65535。このパラメーターが指定されていない場合、BackendServerPort の値が使用されます。

    説明

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

    8000
    EipTransmit

    string

    EIP パススルーを有効にするかどうかを指定します。有効値：

    • on：有効

    • off（デフォルト）：無効

    on

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "ListenerPort": 80,
  "Status": "Stopped",
  "Bandwidth": -1,
  "Scheduler": "wrr",
  "PersistenceTimeout": 0,
  "EstablishedTimeout": 500,
  "HealthCheck": "on",
  "HealthyThreshold": 4,
  "UnhealthyThreshold": 4,
  "HealthCheckConnectTimeout": 100,
  "HealthCheckInterval": 5,
  "Description": "example",
  "HealthCheckHttpCode": "http_2xx",
  "HealthCheckDomain": "example.com",
  "HealthCheckURI": "/example/index.html",
  "HealthCheckType": "tcp",
  "BackendServerPort": 8080,
  "HealthCheckConnectPort": 8000,
  "EipTransmit": "on"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 ens.interface.error An error occurred while call the API.
    400 LoadBalancerNotFound The input parameter loadBalancerId that is not found.
    400 ListenerNotFound Listener is not found.
    400 NoPermission Permission denied.
    400 InvalidParameter.%s The specified field %s invalid. Please check it again.

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

    変更履歴

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