すべてのプロダクト
Search

このプロダクト

    Server Load Balancer:UpdateListenerAttribute

    ドキュメントセンター

    Server Load Balancer:UpdateListenerAttribute

    最終更新日:Dec 21, 2025

    リスナーの名前やアイドル接続タイムアウト期間などの属性を更新します。

    今すぐお試しください

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

    update

    *LoadBalancer

    acs:nlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}
    • nlb:SecurityPolicyId
    		 なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ListenerId

    string

    必須

    リスナー ID。

    lsn-bp1bpn0kn908w4nbw****@443
    ListenerDescription

    string

    任意

    リスナーの名前。

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

    tcpssl_443
    ServerGroupId

    string

    任意

    サーバーグループ ID。

    説明

    • リスナーが TCP を使用する場合、プロトコルが TCP または TCP_UDP であるサーバーグループを指定できます。UDP サーバーグループはサポートされていません。

    • リスナーが UDP を使用する場合、プロトコルが UDP または TCP_UDP であるサーバーグループを指定できます。TCP サーバーグループはサポートされていません。

    • リスナーが TCPSSL を使用する場合、プロトコルが TCP で、クライアント IP 保持が無効になっているサーバーグループを指定できます。クライアント IP 保持が有効になっている TCP サーバーグループ、およびプロトコルが UDP または TCP_UDP であるサーバーグループはサポートされていません。

    sgp-ppdpc14gdm3x4o****
    SecurityPolicyId

    string

    任意

    セキュリティポリシーの ID。

    説明

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

    tls_cipher_policy_1_1
    CertificateIds

    array

    任意

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

    説明

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

    string

    任意

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

    説明

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

    12315790212_166f8204689_1714763408_70998****
    CaCertificateIds

    array

    任意

    CA 証明書。CA 証明書は 1 つだけ指定できます。

    説明

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

    string

    任意

    CA 証明書。CA 証明書は 1 つだけ指定できます。

    説明

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

    139a00604ad-cn-east-hangzh****
    CaEnabled

    boolean

    任意

    相互認証を有効にするかどうかを指定します。有効な値：

    • true

    • false

    false
    IdleTimeout

    integer

    任意

    アイドル接続のタイムアウト期間。単位：秒

    • リスナーが TCP または TCPSSL を使用する場合、このパラメーターを 10～900 の範囲の値に設定できます。デフォルト値：900

    • リスナーが UDP を使用する場合、このパラメーターを 10～20 の範囲の値に設定できます。デフォルト値：20

    900
    DryRun

    boolean

    任意

    ドライランを実行するかどうかを指定します。有効な値：

    • true：操作を実行せずにリクエストを検証します。システムは、不足しているパラメーター値、不正なリクエスト構文、サービスの制限など、リクエストに潜在的な問題がないか確認します。リクエストが検証に失敗した場合、対応するエラーメッセージが返されます。リクエストが検証に成功した場合、DryRunOperation エラーコードが返されます。

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

    false
    ClientToken

    string

    任意

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

    クライアントを使用してトークンを生成できます。トークンが異なるリクエスト間で一意であることを確認してください。ASCII 文字のみが許可されます。

    説明

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

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

    string

    任意

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

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

    cn-hangzhou
    ProxyProtocolEnabled

    boolean

    任意

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

    • true

    • false

    false
    SecSensorEnabled

    boolean

    任意

    高精度監視を有効にするかどうかを指定します。有効な値：

    • true

    • false

    false
    AlpnEnabled

    boolean

    任意

    Application-Layer Protocol Negotiation (ALPN) を有効にするかどうかを指定します。有効な値：

    • true

    • false

    false
    AlpnPolicy

    string

    任意

    ALPN ポリシーの名前。指定できる値は次のとおりです：

    • HTTP1Only：HTTP/1.* のみをネゴシエートします。ALPN プリファレンスリストは HTTP/1.1、HTTP/1.0 です。

    • HTTP2Only：HTTP/2 のみをネゴシエートします。ALPN プリファレンスリストは HTTP/2 です。

    • HTTP2Optional：HTTP/2 よりも HTTP/1.* を優先します。ALPN プリファレンスリストは HTTP/1.1、HTTP/1.0、HTTP/2 です。

    • HTTP2Preferred：HTTP/1.* よりも HTTP/2 を優先します。ALPN プリファレンスリストは HTTP/2、HTTP/1.1、HTTP/1.0 です。

    説明

    AlpnEnabled が true に設定されている場合、このパラメーターは必須です。

    HTTP1Only
    Cps

    integer

    任意

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

    10000
    Mss

    integer

    任意

    TCP パケットの最大セグメントサイズ。単位：バイト。有効な値：0～1500。0 は、最大セグメントサイズ (MSS) が変更されないことを示します。このパラメーターは、TCP リスナーおよび TCP 上の SSL を使用するリスナーでのみサポートされます。

    344
    ProxyProtocolV2Config

    object

    任意

    Proxy プロトコルが VpcId、PrivateLinkEpId、および PrivateLinkEpsId パラメーターをバックエンドサーバーに渡すことを指定します。

    Ppv2VpcIdEnabled

    boolean

    任意

    Proxy プロトコルを使用して VpcId パラメーターをバックエンドサーバーに渡すかどうかを指定します。有効な値：

    • true

    • false

    false
    Ppv2PrivateLinkEpIdEnabled

    boolean

    任意

    Proxy プロトコルを使用して PrivateLinkEpId パラメーターをバックエンドサーバーに渡すかどうかを指定します。有効な値：

    • true

    • false

    false
    Ppv2PrivateLinkEpsIdEnabled

    boolean

    任意

    Proxy プロトコルを使用して PrivateLinkEpsId パラメーターをバックエンドサーバーに渡すかどうかを指定します。有効な値：

    • true

    • false

    false

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    リスナーの構成を更新します。

    RequestId

    string

    リクエストの ID。

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

    string

    非同期タスクの ID。

    72dcd26b-f12d-4c27-b3af-18f6aed5****

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 Mismatch.VpcId The VpcId is mismatched for %s and %s.
    400 Conflict.Port The Port [%s] is conflict. 指定したポートと既存のポートが競合しています
    400 ResourceNotFound.Certificate The specified resource %s is not found.
    400 IncorrectStatus.listener The status of listener [%s] is incorrect.
    400 IdempotenceSignatureMismatch The idempotence token of request is same with the prev one, but the signature is different.
    400 DryRunOperation Request validation has been passed with DryRun flag set. 日文说明6
    400 ResourceAlreadyAssociated.Certificate The specified resource %s is already associated.
    400 IllegalParamSize.certificateIds The param size of certificateIds or caCertificateIds is illegal.
    400 SystemBusy System is busy, please try again later.
    400 IllegalParam.IdleTimeout The param of IdleTimeout is illegal.
    400 OperationDenied.RegionNotSupportHDMonitor The operation is not allowed because of RegionNotSupportHDMonitor.
    400 ResourceNotEnough.CaCertificateApiCount The specified resource of CaCertificateApiCount is not enough.
    400 IllegalParam The param of %s is illegal.
    403 Forbidden.NoPermission Authentication is failed for NoPermission.
    404 ResourceNotFound.listener The specified resource %s is not found.
    404 ResourceNotFound.HdMonitorConfigNotExist The specified resource of HdMonitorConfigNotExist is not found.
    404 ResourceNotFound.CaCertificate The specified resource of CaCertificate is not found.
    404 ResourceNotFound.securitypolicy The specified resource of securitypolicy is not found.

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

    変更履歴

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