すべてのプロダクト
Search

このプロダクト

    ENS:DescribeLoadBalancerUDPListenerAttribute

    ドキュメントセンター

    ENS:DescribeLoadBalancerUDPListenerAttribute

    最終更新日:May 07, 2026

    DescribeLoadBalancerUDPListenerAttribute を呼び出して、UDP リスナーの構成を取得します。

    操作説明

    • API レート制限：100 リクエスト／秒（RPS）。

    • ユーザーごとのレート制限：10 RPS。

    今すぐお試しください

    この 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:DescribeLoadBalancerUDPListenerAttribute

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ListenerPort

    integer

    必須

    クエリするリスナーポート。有効値：1 ～ 65535。

    80
    LoadBalancerId

    string

    必須

    ロードバランサーの ID。

    lb-5pzipr2fszqtl2xf64uy5****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンススキーマ。

    RequestId

    string

    リクエスト ID。

    5D7597CF-1630-54EC-A945-624A33F2E7E8
    ListenerPort

    integer

    リスナーポート。

    80
    Status

    string

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

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

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

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

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

    • Stopping：リスナーが停止処理中です。

    Stopped
    Bandwidth

    integer

    ロードバランサーのピーク帯域幅。値が -1 の場合、レート制限が適用されていません。

    5
    Scheduler

    string

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

    • wrr（Weighted Round Robin）：重みが高いバックエンドサーバーほど多くのリクエストを受け取ります。

    • wlc（Weighted Least Connections）：各バックエンドサーバーの重みと現在の接続数に基づいてリクエストを分散します。バックエンドサーバーの重みが同じ場合、接続数が最も少ないサーバーに新しいリクエストが多く割り当てられます。

    • rr（Round Robin）：リクエストをバックエンドサーバーに順番に分散します。

    • sch（Source IP Hash）：送信元 IP アドレスの一貫したハッシュを使用して、同じ送信元 IP アドレスからのリクエストを同じバックエンドサーバーにルートします。

    • tch（4-tuple Hash）：4 タプル（送信元 IP アドレス、宛先 IP アドレス、送信元ポート、宛先ポート）の一貫したハッシュを使用して、同じフローからのパケットを同じバックエンドサーバーにルートします。

    • qch（QUIC Connection ID Hash）：QUIC 接続 ID に対して一貫したハッシュアルゴリズムを使用し、同じ接続 ID を持つリクエストが常に同じバックエンドサーバーにルートされるようにします。

    • iqch（iQUIC CID Hash）：iQUIC CID の 2、3、4 バイトに対して一貫したハッシュアルゴリズムを使用します。これらの 3 バイトが同じリクエストは同じバックエンドサーバーにルートされます。

    wrr
    HealthCheck

    string

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

    • on：有効。

    • off：無効。

    on
    HealthyThreshold

    integer

    バックエンドサーバーが正常とみなされるまでに必要な連続した正常なヘルスチェックの回数。有効値：2 ～ 10。

    説明

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

    4
    UnhealthyThreshold

    integer

    バックエンドサーバーが異常とみなされるまでに必要な連続した失敗したヘルスチェックの回数。有効値：2 ～ 10。

    説明

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

    4
    HealthCheckConnectTimeout

    integer

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

    • デフォルト値：5。

    • 有効値：1 ～ 300。

    • 単位：秒。

    説明

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

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

    100
    HealthCheckInterval

    integer

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

    説明

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

    5
    Description

    string

    リスナー名。

    example
    BackendServerPort

    integer

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

    8080
    HealthCheckConnectPort

    integer

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

    8000
    HealthCheckReq

    string

    UDP ヘルスチェックのリクエスト文字列。文字列には英数字のみを使用でき、最大 64 文字までです。

    hello
    HealthCheckExp

    string

    UDP ヘルスチェックの応答文字列。文字列には英数字のみを使用でき、最大 64 文字までです。

    ok
    EipTransmit

    string

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

    • on：有効。

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

    on
    EstablishedTimeout

    integer

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

    500

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "5D7597CF-1630-54EC-A945-624A33F2E7E8",
  "ListenerPort": 80,
  "Status": "Stopped",
  "Bandwidth": 5,
  "Scheduler": "wrr",
  "HealthCheck": "on",
  "HealthyThreshold": 4,
  "UnhealthyThreshold": 4,
  "HealthCheckConnectTimeout": 100,
  "HealthCheckInterval": 5,
  "Description": "example",
  "BackendServerPort": 8080,
  "HealthCheckConnectPort": 8000,
  "HealthCheckReq": "hello",
  "HealthCheckExp": "ok",
  "EipTransmit": "on",
  "EstablishedTimeout": 500
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

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

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

    変更履歴

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