すべてのプロダクト
Search

このプロダクト

    ENS:SetLoadBalancerTCPListenerAttribute

    ドキュメントセンター

    ENS:SetLoadBalancerTCPListenerAttribute

    最終更新日:Aug 14, 2026

    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

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    LoadBalancerId

    string

    必須

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

    lb-5snthcyu1x10g7tywj7iu****
    ListenerPort

    integer

    必須

    属性を変更するリスナーのポート。有効な値: 1 から 65535。

    80
    Description

    string

    任意

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

    説明

    説明は http:// または https:// で始めることはできません。

    example
    Scheduler

    string

    任意

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

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

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

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

    • sch: ソース IP アドレスに基づく一貫したハッシュ化。同じソース IP アドレスからのリクエストは同じバックエンドサーバーに分散されます。

    • tch: 4 つの要素 (送信元 IP アドレス、送信先 IP アドレス、送信元ポート、宛先ポート) に基づく一貫したハッシュ化。同じフローからのリクエストは同じバックエンドサーバーに分散されます。

    列挙値:

    • rr :

      ラウンドロビン。

    • wrr :

      重み付きラウンドロビン。

    • tch :

      4 要素一貫ハッシュ化。

    • sch :

      ソース IP 一貫ハッシュ化。

    • wlc :

      重み付き最小接続数。

    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

    任意

    2 つの連続したヘルスチェックの間隔。有効な値: 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 :

      TCP。

    • http :

      HTTP。

    tcp
    EipTransmit

    string

    任意

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

    • on: 有効。

    • off (デフォルト): 無効。

    列挙値:

    • off :

      無効。

    • on :

      有効。

    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.

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

    変更履歴

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