PrevNext
search by keyword

Recent Pages

Documentation
Cloud Load Balancer
    Documentation
    Download PDF

    ModifyListener

    Last updated: 2021-11-16 16:47:28
    Download PDF

    1. API Description

    Domain name for API request: clb.tencentcloudapi.com.

    This API (ModifyListener) is used to modify the attributes of a CLB listener, such as listener name, health check parameter, certificate information, and forwarding policy.
    This is an async API. After it is returned successfully, you can call the DescribeTaskStatus API with the returned RequestID as an input parameter to check whether this task is successful.

    A maximum of 20 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common parameter. The value used for this API: ModifyListener.
    Version Yes String Common parameter. The value used for this API: 2018-03-17.
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    LoadBalancerId Yes String CLB instance ID
    ListenerId Yes String CLB listener ID
    ListenerName No String New listener name
    SessionExpireTime No Integer Session persistence time in seconds. Value range: 30-3,600. The default value is 0, indicating that session persistence is not enabled. This parameter is applicable only to TCP/UDP listeners.
    HealthCheck No HealthCheck Health check parameter, which is applicable only to TCP, UDP, and TCP_SSL listeners.
    Certificate No CertificateInput Certificate information. This parameter is applicable only to HTTPS and TCP_SSL listeners.
    Scheduler No String Forwarding method of a listener. Value range: WRR, LEAST_CONN.
    They represent weighted round robin and least connections, respectively. Default value: WRR.
    SniSwitch No Integer Whether to enable the SNI feature. This parameter is applicable only to HTTPS listeners. Note: The SNI feature can be enabled but cannot be disabled once enabled.
    KeepaliveEnable No Integer Whether to enable a persistent connection. This parameter is applicable only to HTTP and HTTPS listeners.
    DeregisterTargetRst No Boolean Whether to send the TCP RST packet to the client when unbinding a real server. This parameter is applicable to TCP listeners only.
    SessionType No String Session persistence type. NORMAL: default session persistence type (L4/L7 session persistence); QUIC_CID: session persistence by QUIC connection ID. The QUIC_CID value can only be configured in UDP listeners.

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Modifying the name, health check parameters, and forwarding policy of a TCP listener

    Input Example

    https://clb.tencentcloudapi.com/?Action=ModifyListener
&LoadBalancerId=lb-cuxw2rm0
&ListenerId=lbl-d1ubsydq
&ListenerName=newlis
&SessionExpireTime=120
&Scheduler=LEAST_CONN
&HealthCheck.HealthSwitch=1
&HealthCheck.TimeOut=35
&HealthCheck.IntervalTime=60
&HealthCheck.HealthNum=5
&HealthCheck.UnHealthNum=5
&<Common request parameters>

    Output Example

    {
  "Response": {
    "RequestId": "8cd88c83-fd30-47c0-8e7a-89bf13a7a83c"
  }
}

    Example2 Modifying the certificate bound to an HTTPS listener

    Input Example

    https://clb.tencentcloudapi.com/?Action=ModifyListener
&LoadBalancerId=lb-cuxw2rm0
&ListenerId=lbl-4fbxq45k
&Certificate.SSLMode=UNIDIRECTIONAL
&Certificate.CertId=Nb1DY3hQ
&<Common request parameters>

    Output Example

    {
  "Response": {
    "RequestId": "b64574f9-5bc7-4a63-a9d7-3671b6a6d62b"
  }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation Operation failed.
    InternalError Internal error.
    InvalidParameter Parameter error.
    InvalidParameter.FormatError Wrong parameter format.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.Length Wrong parameter length.
    MissingParameter Missing parameter.
    UnauthorizedOperation Unauthorized operation.
    tencent
    Copyright © 2013-2022 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy