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.
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 Params. The value used for this API: ModifyListener. |
Version | Yes | String | Common Params. The value used for this API: 2018-03-17. |
Region | No | String | Common Params. This parameter is not required for this API. |
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. It is only applicable only to TCP, UDP, TCP_SSL and QUIC listeners. |
Certificate | No | CertificateInput | Certificate information. This parameter is only applicable to HTTPS/TCP_SSL/QUIC listeners. Certificate and MultiCertInfo cannot be both specified. |
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. |
TargetType | No | String | Target backend type. NODE : A single node; TARGETGROUP : A target group. |
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. |
MultiCertInfo | No | MultiCertInfo | Certificate information. You can specify multiple server-side certificates with different algorithm types. This parameter is only applicable to HTTPS listeners with the SNI feature not enabled. Certificate and MultiCertInfo cannot be specified at the same time. |
MaxConn | No | Integer | The maximum number of concurrent connections at the listener level. This parameter takes effect only on LCU-supported instances and TCP/UDP/TCP_SSL/QUIC listeners. Value range: 1 to the maximum concurrency of the instance. -1 indicates that no limit is set on concurrent connections. |
MaxCps | No | Integer | The maximum number of new connections at the listener level. This parameter takes effect only on LCU-supported instances and TCP/UDP/TCP_SSL/QUIC listeners. Value range: 1 to the maximum number of new connections of the instance. -1 indicates that no limit is set on concurrent connections. |
IdleConnectTimeout | No | Integer | Connection idle timeout period (in seconds). It’s only available to TCP listeners. Value range: 300-900 for shared and dedicated instances; 300-2000 for LCU-supported CLB instances. It defaults to 900. To set a period longer than 2000 seconds (up to 3600 seconds), please submit a submit. |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to modify the name, health check parameters, and forwarding policy of a TCP listener.
POST / HTTP/1.1
Host: clb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyListener
<Common request parameters>
{
"HealthCheck": {
"UnHealthNum": "5",
"HealthNum": "5",
"IntervalTime": "60",
"TimeOut": "35",
"HealthSwitch": "1"
},
"LoadBalancerId": "lb-cuxw2rm0",
"ListenerId": "lbl-d1ubsydq",
"ListenerName": "newlis",
"Scheduler": "LEAST_CONN",
"SessionExpireTime": "120"
}
{
"Response": {
"RequestId": "8cd88c83-fd30-47c0-8e7a-89bf13a7a83c"
}
}
This example shows you how to modify the certificate bound to an HTTPS listener.
POST / HTTP/1.1
Host: clb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyListener
<Common request parameters>
{
"ListenerId": "lbl-4fbxq45k",
"Certificate": {
"SSLMode": "UNIDIRECTIONAL",
"CertId": "Nb1DY3hQ"
},
"LoadBalancerId": "lb-cuxw2rm0"
}
{
"Response": {
"RequestId": "b64574f9-5bc7-4a63-a9d7-3671b6a6d62b"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
문제 해결에 도움이 되었나요?