すべてのプロダクト
Search

このプロダクト

    :GetListenerAttribute

    ドキュメントセンター

    :GetListenerAttribute

    最終更新日:Jan 04, 2026

    Network Load Balancer (NLB) のリスナーの詳細を照会します。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    nlb:GetListenerAttribute

    get

    *LoadBalancer

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ListenerId

    string

    必須

    リスナー ID。

    lsn-bp1bpn0kn908w4nbw****@233
    DryRun

    boolean

    任意

    リクエストを実際に送信せずに、ドライランを実行するかどうかを指定します。有効な値：

    • true：ドライランのみを実行します。システムは、パラメーター値の不足、リクエスト構文の誤り、サービスの制限など、リクエストに潜在的な問題がないかチェックします。リクエストがドライランに失敗した場合、エラーメッセージが返されます。リクエストがドライランに成功した場合、DryRunOperation エラーコードが返されます。

    • false (デフォルト)：ドライランを実行し、実際のリクエストを送信します。リクエストがドライランに成功した場合、2xx HTTP ステータスコードが返され、操作が実行されます。

    false
    ClientToken

    string

    任意

    リクエストのべき等性を保証するために使用されるクライアントトークン。

    クライアントを使用して値を生成できますが、すべてのリクエストで一意であることを確認する必要があります。ClientToken には ASCII 文字のみを含めることができます。

    説明

    このパラメーターを設定しない場合、ClientToken は RequestId の値に設定されます。RequestId の値はリクエストごとに異なります。

    123e4567-e89b-12d3-a456-426655440000
    RegionId

    string

    任意

    NLB インスタンスが配置されているリージョン ID。

    DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。

    cn-hangzhou

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    リスナーの属性を照会する操作。

    RequestId

    string

    リクエスト ID。

    CEF72CEB-54B6-4AE8-B225-F876FF7BA984
    RegionId

    string

    NLB インスタンスがデプロイされているリージョン ID。

    cn-hangzhou
    LoadBalancerId

    string

    NLB インスタンスの ID。

    nlb-83ckzc8d4xlp8o****
    ListenerId

    string

    リスナーの ID。

    lsn-bp1bpn0kn908w4nbw****@233
    ListenerProtocol

    string

    リッスンプロトコル。有効な値：TCP、UDP、TCPSSL。

    TCPSSL
    ListenerPort

    integer

    リッスンポート。有効な値：0～65535。値 0 はすべてのポートを指定します。値を 0 に設定する場合は、StartPort および EndPort パラメーターも設定する必要があります。

    233
    StartPort

    string

    リッスンポート範囲の最初のポート。有効な値：0～65535。

    233
    EndPort

    string

    リッスンポート範囲の最後のポートです。有効値の範囲は 0～65535 で、最後のポートは最初のポートより小さい値である必要があります。

    455
    ListenerDescription

    string

    リスナーの名前。

    名前は 2～256 文字で、文字、数字、カンマ (,)、ピリオド (.)、セミコロン (;)、スラッシュ (/)、アットマーク (@)、アンダースコア (_)、ハイフン (-) を使用できます。

    tcpssl_443
    ServerGroupId

    string

    サーバーグループの ID。

    sgp-ppdpc14gdm3x4o****
    IdleTimeout

    integer

    アイドル接続のタイムアウト期間。単位：秒。有効な値：1～900。

    900
    SecurityPolicyId

    string

    セキュリティポリシーの ID。システムのセキュリティポリシーとカスタムセキュリティポリシーがサポートされています。

    • 有効な値：tls_cipher_policy_1_0、tls_cipher_policy_1_1、tls_cipher_policy_1_2、tls_cipher_policy_1_2_strict、tls_cipher_policy_1_2_strict_with_1_3。

    • カスタムセキュリティポリシー：カスタムセキュリティポリシーの ID。

      • カスタムセキュリティポリシーの作成方法の詳細については、「CreateSecurityPolicy」をご参照ください。

      • セキュリティポリシーの照会方法の詳細については、「ListSecurityPolicy」をご参照ください。

    説明

    このパラメーターは、TCP 上の SSL を使用するリスナーに対してのみ有効です。

    tls_cipher_policy_1_0
    CertificateIds

    array

    サーバー証明書。サーバー証明書は 1 つのみサポートされます。

    説明

    このパラメーターは、TCP 上の SSL を使用するリスナーに対してのみ有効です。

    string

    サーバー証明書。

    123157******
    CaCertificateIds

    array

    CA 証明書。CA 証明書は 1 つのみサポートされます。

    説明

    このパラメーターは、TCP 上の SSL を使用するリスナーに対してのみ有効です。

    string

    CA 証明書。CA 証明書は 1 つのみサポートされます。

    説明

    このパラメーターは、TCP 上の SSL を使用するリスナーに対してのみ有効です。

    139a00******
    CaEnabled

    boolean

    相互認証が有効になっているかどうかを示します。有効な値：

    • true：はい

    • false：いいえ

    false
    AlpnEnabled

    boolean

    Application-Layer Protocol Negotiation (ALPN) が有効になっているかどうかを示します。有効な値：

    • true：はい

    • false：いいえ

    false
    AlpnPolicy

    string

    ALPN ポリシー。有効な値：

    • HTTP1Only

    • HTTP2Only

    • HTTP2Preferred

    • HTTP2Optional

    HTTP1Only
    ProxyProtocolEnabled

    boolean

    Proxy Protocol を使用してクライアント IP アドレスをバックエンドサーバーに渡すかどうかを示します。有効な値：

    • true：はい

    • false：いいえ

    false
    ProxyProtocolV2Config

    object

    Proxy Protocol が VpcId、PrivateLinkEpId、および PrivateLinkEpsId パラメーターをバックエンドサーバーに渡すかどうかを示します。

    Ppv2VpcIdEnabled

    boolean

    Proxy Protocol が VpcId パラメーターをバックエンドサーバーに渡すかどうかを示します。有効な値：

    • true

    • false

    false
    Ppv2PrivateLinkEpIdEnabled

    boolean

    Proxy Protocol が PrivateLinkEpId パラメーターをバックエンドサーバーに渡すかどうかを示します。有効な値：

    • true

    • false

    false
    Ppv2PrivateLinkEpsIdEnabled

    boolean

    Proxy Protocol が PrivateLinkEpsId パラメーターをバックエンドサーバーに渡すかどうかを示します。有効な値：

    • true

    • false

    false
    SecSensorEnabled

    boolean

    高精度監視が有効になっているかどうかを示します。有効な値：

    • true：はい

    • false：いいえ

    false
    ListenerStatus

    string

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

    • Provisioning：リスナーは作成中です。

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

    • Configuring：リスナーは設定中です。

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

    • Stopped：リスナーは停止済みです。

    • Starting：リスナーは開始中です。

    • Deleting：リスナーは削除中です。

    • Deleted：リスナーは削除済みです。

    Running
    Cps

    integer

    各ゾーン (仮想 IP アドレス) のリスナーでサポートされる 1 秒あたりの最大新規接続数。有効な値：0～1000000。0 は接続数が無制限であることを示します。

    1000
    Mss

    integer

    最大 TCP セグメントのサイズ。単位：バイト。有効な値：0～1500。0 は、最大セグメントサイズが変更されないことを指定します。

    説明

    このパラメーターは、TCP 上の SSL を使用するリスナーでのみサポートされます。

    166
    Tags

    array<object>

    タグ。

    object

    実行のタグ。

    TagKey

    string

    タグキー。

    ac-cus-tag-4
    TagValue

    string

    タグ値。

    ON

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "RegionId": "cn-hangzhou",
  "LoadBalancerId": "nlb-83ckzc8d4xlp8o****",
  "ListenerId": "lsn-bp1bpn0kn908w4nbw****@233",
  "ListenerProtocol": "TCPSSL",
  "ListenerPort": 233,
  "StartPort": "233",
  "EndPort": "455",
  "ListenerDescription": "tcpssl_443",
  "ServerGroupId": "sgp-ppdpc14gdm3x4o****",
  "IdleTimeout": 900,
  "SecurityPolicyId": "tls_cipher_policy_1_0",
  "CertificateIds": [
    "123157******"
  ],
  "CaCertificateIds": [
    "139a00******"
  ],
  "CaEnabled": false,
  "AlpnEnabled": false,
  "AlpnPolicy": "HTTP1Only",
  "ProxyProtocolEnabled": false,
  "ProxyProtocolV2Config": {
    "Ppv2VpcIdEnabled": false,
    "Ppv2PrivateLinkEpIdEnabled": false,
    "Ppv2PrivateLinkEpsIdEnabled": false
  },
  "SecSensorEnabled": false,
  "ListenerStatus": "Running",
  "Cps": 1000,
  "Mss": 166,
  "Tags": [
    {
      "TagKey": "ac-cus-tag-4",
      "TagValue": "ON"
    }
  ]
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 SystemBusy System is busy, please try again later.
    404 ResourceNotFound.loadBalancer The specified resource of loadbalancer is not found.
    404 ResourceNotFound.listener The specified resource %s is not found.

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

    変更履歴

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