すべてのプロダクト
Search

このプロダクト

    ENS:DescribeLoadBalancerUDPListenerAttribute

    ドキュメントセンター

    ENS:DescribeLoadBalancerUDPListenerAttribute

    最終更新日:Mar 20, 2026

    ユーザーデータグラムプロトコル (UDP) リスナーの設定を照会します。

    操作説明

    • 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:DescribeLoadBalancerUDPListenerAttribute

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ListenerPort

    integer

    必須

    照会するリッスンポート。有効値：1～65535。

    80
    LoadBalancerId

    string

    必須

    ELB インスタンスの 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

    Edge Load Balancer (ELB) インスタンスのピーク帯域幅。デフォルト値は -1 で、帯域幅が無制限であることを示します。

    5
    Scheduler

    string

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

    • wrr：重みが大きいバックエンドサーバーほど、多くのリクエストを受信します。

    • wlc：各バックエンドサーバーの重みと負荷 (接続数) に基づいてリクエストが分散されます。2 つのバックエンドサーバーの重みが同じ場合、接続数が少ないサーバーがより多くのリクエストを受信します。

    • rr：リクエストはバックエンドサーバーに順番に分散されます。

    • sch：送信元 IP アドレスに基づく一貫性ハッシュ。同じ送信元 IP アドレスからのリクエストは、同じバックエンドサーバーに分散されます。

    • qch：QUIC 接続 ID に基づく一貫性ハッシュ。同じ QUIC 接続 ID を含むリクエストは、同じバックエンドサーバーに分散されます。

    • iqch：iQUIC CID の特定の 3 バイトに基づく一貫性ハッシュ。2 バイト目から 4 バイト目が同じリクエストは、同じバックエンドサーバーに分散されます。

    wrr
    HealthCheck

    string

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

    • on

    • off

    on
    HealthyThreshold

    integer

    異常でアクセス不可と判断されたバックエンドサーバーが、正常でアクセス可能と判断されるまでに必要な、連続したヘルスチェックの成功回数。有効値：2～10。

    説明

    このパラメーターは、HealthCheck を on に設定した場合にのみ有効です。

    4
    UnhealthyThreshold

    integer

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

    説明

    このパラメーターは、HealthCheck を on に設定した場合にのみ有効です。

    4
    HealthCheckConnectTimeout

    integer

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

    • デフォルト値：5。

    • 有効値：1～300。

    • 単位：秒。

    説明

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

    • HealthCheckTimeout プロパティの値が HealthCheckInterval プロパティの値より小さい場合、HealthCheckTimeout プロパティで指定されたタイムアウト期間は無効になり、HealthCheckInterval プロパティの値がタイムアウト期間として使用されます。

    100
    HealthCheckInterval

    integer

    ヘルスチェックが実行される間隔。有効値：1～50。単位：秒。

    説明

    このパラメーターは、HealthCheck を on に設定した場合にのみ有効です。

    5
    Description

    string

    リスナーの名前。

    example
    BackendServerPort

    integer

    ELB インスタンスのバックエンドサーバーが使用するポート。有効値：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.

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

    変更履歴

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