すべてのプロダクト
Search

このプロダクト

    ENS:SetLoadBalancerTCPListenerAttribute

    ドキュメントセンター

    ENS:SetLoadBalancerTCPListenerAttribute

    最終更新日:May 07, 2026

    SetLoadBalancerTCPListenerAttribute を呼び出して、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:SetLoadBalancerTCPListenerAttribute

    update

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    LoadBalancerId

    string

    必須

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

    lb-5snthcyu1x10g7tywj7iu****
    ListenerPort

    integer

    必須

    変更するリスナーポートです。有効値：1 ～ 65535。

    80
    Description

    string

    任意

    リスナーの説明です。説明は 1 ～ 80 文字である必要があります。

    説明

    説明は http:// または https:// で開始できません。

    example
    Scheduler

    string

    任意

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

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

    • wlc (Weighted Least Connections)：各バックエンドサーバーの重みに加えて、各サーバーへの接続数も考慮します。複数のサーバーが同じ重みを持つ場合、接続数が最も少ないサーバーが次のリクエストを受け取ります。

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

    • sch (Source-based Consistent Hashing)：同一ソース IP アドレスからのリクエストは、常に同じバックエンドサーバーにルーティングされます。

    • tch (Four-tuple-based Consistent Hashing)：送信元 IP、送信先 IP、送信元ポート、送信先ポートで識別される同一フローからのリクエストは、常に同じバックエンドサーバーにルーティングされます。

    wrr
    PersistenceTimeout

    integer

    任意

    セッション維持のタイムアウト時間です。

    • デフォルト値：0（セッション維持を無効化）。

    • 有効値：0 ～ 3600。

    • 単位：秒。

    0
    EstablishedTimeout

    integer

    任意

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

    500
    HealthyThreshold

    integer

    任意

    正常でないバックエンドサーバーを正常とみなすために必要な、連続するヘルスチェック成功回数です。有効値：2 ～ 10。

    4
    UnhealthyThreshold

    integer

    任意

    正常なバックエンドサーバーを異常とみなすために必要な、連続するヘルスチェック失敗回数です。有効値：2 ～ 10。

    4
    HealthCheckConnectTimeout

    integer

    任意

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

    • デフォルト値：5。

    • 有効値：1 ～ 300。

    • 単位：秒。

    説明

    HealthCheckConnectTimeout の値が HealthCheckInterval の値より小さい場合、HealthCheckConnectTimeout の設定は無視され、タイムアウトとして HealthCheckInterval の値が使用されます。

    100
    HealthCheckConnectPort

    integer

    任意

    ヘルスチェックに使用するポートです。有効値：1 ～ 65535。省略した場合、バックエンドサービスポート (BackendServerPort) が使用されます。

    8000
    HealthCheckInterval

    integer

    任意

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

    5
    HealthCheckDomain

    string

    任意

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

    www.aliyundoc.com
    HealthCheckURI

    string

    任意

    ヘルスチェック用の URI です。URI は 1 ～ 80 文字である必要があります。

    説明

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

    /aliyundoc/index.html
    HealthCheckHttpCode

    string

    任意

    ヘルスチェック成功を示す HTTP ステータスコードです。有効値：

    • http_2xx（デフォルト）。

    • http_3xx。

    • http_4xx。

    • http_5xx。

    http_2xx
    HealthCheckType

    string

    任意

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

    • tcp（デフォルト）。

    • http。

    tcp
    EipTransmit

    string

    任意

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

    • on：EIP パススルーを有効化します。

    • off（デフォルト）：EIP パススルーを無効化します。

    on

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンススキーマです。

    RequestId

    string

    リクエスト ID です。

    06F00FBB-3D9E-4CCE-9D43-1A6946A75456

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "06F00FBB-3D9E-4CCE-9D43-1A6946A75456"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 ens.interface.error An error occurred while call the API.
    400 Invalid%s The specified parameter %s is invalid.
    400 Missing%s You must specify the parameter %s.
    400 LoadBalancerNotFound The input parameter loadBalancerId that is not found.
    400 IncorrectInstanceStatus The current status of the resource does not support this operation.
    400 ListenerNotFound The input parameter listener that is not found.
    400 IncorrectListenerStatus The current status of the resource does not support this operation.
    400 NoPermission Permission denied.
    400 InvalidParameter.%s The specified field %s invalid. Please check it again.

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

    変更履歴

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