릴리스 정보 및 공지 사항

릴리스 노트

제품 공지

제품 소개

제품 개요

제품 장점

시나리오

기술 원리

Product Comparison

사용 제한

Service Regions and Service Providers

구매 가이드

과금 개요

비용 계산 항목

구매 방식

연체 안내

제품 속성 선택

시작하기

도메인 이름 기반 CLB 시작하기

CLB 시작하기

CentOS에서 Nginx 배포하기

CentOS에서 Java Web 배포하기

운영 가이드

CLB 인스턴스

CLB 리스너

리얼 서버

상태 확인

인증서 관리

로그 관리

모니터링 및 알람

액세스 관리

사례 튜토리얼

CLB에 인증서 배치(양방향 인증)

HTTPS 포워딩 구성

리얼 클라이언트 IP 가져오기

로드 밸런싱 구성 모니터링 및 알람에 대한 모범 사례

다중 가용존에서 HA 구현

로드 밸런싱 알고리즘 선택 및 가중치 구성 예시

CLB 수신 도메인 이름에 대한 WAF 보호 구성하기

OPS 가이드

과도한 TIME_WAIT 상태의 클라이언트에 대한 솔루션

CLB HTTPS 서비스 성능 테스트

스트레스 테스트 FAQ

CLB 인증서 작업 권한

문제 해결

UDP 상태 확인 예외 발생

API 참조

History

Introduction

API Category

Instance APIs

Listener APIs

Backend Service APIs

Target Group APIs

Redirection APIs

Other APIs

Classic CLB APIs

Load Balancing APIs

Making API Requests

Data Types

Error Codes

CLB API 2017

FAQ

과금 관련

CLB 구성

헬스체크 이상 점검

HTTPS

WS/WSS 프로토콜 지원

HTTP/2 프로토콜 지원

연락처

용어집

ModifyLoadBalancerListener

PDF

포커스 모드

폰트 크기

마지막 업데이트 시간: 2024-12-19 17:03:36

API Description
 This API is used to modify the attributes of CLB listeners.
Domain name for API calls: lb.api.qcloud.com
Request Parameters
The list below contains only the API request parameters. Common parameters should be added when you call the API. For more information, see Common Request Parameters. The Action field for this API is ModifyLoadBalancerListener.
Parameter
Required
Type
Description
loadBalancerId
Yes
String
CLB instance ID, which can be queried via the DescribeLoadBalancers API.
loadBalancerId
Yes
String
CLB listener ID, which can be queried via the  DescribeLoadBalancerListeners API.
listenerName
No
String
Listener name.
sessionExpire
No
Int
Session persistence duration. 0: disable. Value range: 30-3600.
healthSwitch
No
Int
Whether to enable health check.1: enable; 0: disable.
timeOut
No
Int
Response timeout. Value range: 2-60 seconds;
This parameter cannot be specified for public network CLB listener with HTTP or HTTPS protocol.
intervalTime
No
Int
Interval between health checks. Value range: 5-300 seconds. Default value: 5.
healthNum
No
Int
Healthy threshold. Value range: 2-10.
unhealthNum
No
Int
Unhealthy threshold. Value range: 2-10.
scheduler
No
String
Forwarding method of the CLB listener. This field cannot be passed in together with httpHash. Only public network CLB listeners with TCP or UDP protocol support this field. Valid values: wrr (weighted round robin), least_conn (least connection).
httpHash
No
String
Forwarding method of the CLB listener. Only public network CLB listener with HTTP or HTTPS protocol support this field. Valid values: wrr (weighted round robin), ip_hash (forwarding the hash of the source IP to the real server), least_conn (least connection).
Default value: wrr.
httpCode
No
Int
Return code for the health check of HTTP or HTTPS CLB listeners. Valid range: 1-31. Default value: 31.
1 represents a return code of 1xx (healthy). 2 represents a return code of 2xx (healthy). 4 represents a return code of 3xx (healthy). 8 represents a return code of 4xx (healthy). 16 represents a return code of 5xx (healthy). If there are multiple codes that can show the healthy status, enter the accumulated value corresponding to such codes.
httpCheckPath
No
String
Health check path for the public network CLB listener with HTTP or HTTPS protocol. Default is /. It must start with /.
SSLMode
No
String
Verification mode of the public network CLB listener with HTTPS protocol. unidirectional: unidirectional verification; mutual: mutual verification.
certId
No
String
New server certificate ID of the public network CLB listener with HTTPS protocol.
certCaId
No
String
New client certificate ID of the public network CLB listener with HTTPS protocol.
certCaContent
No
String
New client certificate content of the public network CLB listener with HTTPS protocol.
certCaName
No
String
New client certificate name of the public network CLB listener with HTTPS protocol.
certContent
No
String
New server certificate content of the public network CLB listener with HTTPS protocol.
certKey
No
String
New server certificate key of the public network CLB listener with HTTPS protocol.
certName
No
String
New server certificate name of the public network CLB listener with HTTPS protocol.
Response Parameters
Parameter
Type
Description
code
Int
Common error code. 0: success; other values: failure. For more information, see Common Error Codes.
message
String
API-related module error message description.
codeDesc
String
Error code. For a successful operation, "Success" is returned. For a failed operation, a message describing the failure is returned.
requestId
Int
Request task ID. You can use this field to query the operation status via the DescribeLoadBalancersTaskResult API.
Example
Request
https://lb.api.qcloud.com/v2/index.php?Action=ModifyLoadBalancerListener
&<Common request parameters>
loadBalancerId=lb-ltkip4do
&listenerId=lbl-6hkiqc6c
&SSLMode=unidirectional
﻿
Response
{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "requestId": 18642
}
﻿
﻿

도움말 및 지원

문제 해결에 도움이 되었나요?

더 자세한 내용은 문의하기 또는 티겟 제출 을 통해 문의할 수 있습니다.

피드백

tencent cloud

Cloud Load Balancer

ModifyLoadBalancerListener

API Description

Request Parameters

Response Parameters

Example

도움말 및 지원

Parameter	Required	Type	Description
loadBalancerId	Yes	String	CLB instance ID, which can be queried via the DescribeLoadBalancers API.
loadBalancerId	Yes	String	CLB listener ID, which can be queried via the DescribeLoadBalancerListeners API.
listenerName	No	String	Listener name.
sessionExpire	No	Int	Session persistence duration. 0: disable. Value range: 30-3600.
healthSwitch	No	Int	Whether to enable health check.1: enable; 0: disable.
timeOut	No	Int	Response timeout. Value range: 2-60 seconds; This parameter cannot be specified for public network CLB listener with HTTP or HTTPS protocol.
intervalTime	No	Int	Interval between health checks. Value range: 5-300 seconds. Default value: 5.
healthNum	No	Int	Healthy threshold. Value range: 2-10.
unhealthNum	No	Int	Unhealthy threshold. Value range: 2-10.
scheduler	No	String	Forwarding method of the CLB listener. This field cannot be passed in together with `httpHash`. Only public network CLB listeners with TCP or UDP protocol support this field. Valid values: wrr (weighted round robin), least_conn (least connection).
httpHash	No	String	Forwarding method of the CLB listener. Only public network CLB listener with HTTP or HTTPS protocol support this field. Valid values: wrr (weighted round robin), ip_hash (forwarding the hash of the source IP to the real server), least_conn (least connection). Default value: wrr.
httpCode	No	Int	Return code for the health check of HTTP or HTTPS CLB listeners. Valid range: 1-31. Default value: 31. 1 represents a return code of 1xx (healthy). 2 represents a return code of 2xx (healthy). 4 represents a return code of 3xx (healthy). 8 represents a return code of 4xx (healthy). 16 represents a return code of 5xx (healthy). If there are multiple codes that can show the healthy status, enter the accumulated value corresponding to such codes.
httpCheckPath	No	String	Health check path for the public network CLB listener with HTTP or HTTPS protocol. Default is /. It must start with /.
SSLMode	No	String	Verification mode of the public network CLB listener with HTTPS protocol. unidirectional: unidirectional verification; mutual: mutual verification.
certId	No	String	New server certificate ID of the public network CLB listener with HTTPS protocol.
certCaId	No	String	New client certificate ID of the public network CLB listener with HTTPS protocol.
certCaContent	No	String	New client certificate content of the public network CLB listener with HTTPS protocol.
certCaName	No	String	New client certificate name of the public network CLB listener with HTTPS protocol.
certContent	No	String	New server certificate content of the public network CLB listener with HTTPS protocol.
certKey	No	String	New server certificate key of the public network CLB listener with HTTPS protocol.
certName	No	String	New server certificate name of the public network CLB listener with HTTPS protocol.