tencent cloud

Cloud Load Balancer

릴리스 정보 및 공지 사항
릴리스 노트
제품 공지
제품 소개
제품 개요
제품 장점
시나리오
기술 원리
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 프로토콜 지원
연락처
용어집
문서Cloud Load BalancerAPI 참조CLB API 2017Classic CLB APIsAPIs for ListenersDescribeLoadBalancerListeners

DescribeLoadBalancerListeners

PDF
포커스 모드
폰트 크기
마지막 업데이트 시간: 2024-12-19 17:06:08

API Description

This API is used to query the list of listeners by CLB ID, listener protocol or port.
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 the Common Request Parameters. The Action field for this API is DescribeLoadBalancerListeners.
Parameter
Required
Type
Description
loadBalancerId
Yes
String
CLB instance ID, which can be queried via the DescribeLoadBalancers API.
listenerIds.n
No
String
CLB listener ID.
protocol
No
Int
Protocol type of the listener.
1: HTTP; 2: TCP; 3: UDP; 4: HTTPS.
loadBalancerPort
No
Int
Port of the CLB listener.
status
No
Int
Status of the CLB listener. This field will be ignored when listenerIds.n is specified.

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.
totalCount
Int
Total number of CLB listeners that meet the filter condition.
listenerSet
Array
Listener array returned.
Structure of the listenerSet array returned
Parameter
Type
Description
listenerId
String
CLB listener ID.
unListenerId
String
CLB listener ID.
loadBalancerPort
Int
Listening port of the CLB listener.
instancePort
Int
Forwarding port of the listener.
listenerName
String
Listener name.
protocol
Int
Protocol type of the listener.
1: HTTP; 2: TCP; 3: UDP; 4: HTTPS.
sessionExpire
Int
Session persistence duration.
healthSwitch
Int
Whether to enable the health check. 1: enable; 0: disable.
timeOut
Int
Response timeout.
intervalTime
Int
Interval between health checks.
healthNum
Int
Healthy threshold.
unhealthNum
Int
Unhealthy threshold.
httpHash
String
Forwarding method of the HTTP or HTTPS listener of a public network classic CLB instance.
scheduler
String
Forwarding method of the UDP or TCP listener of a public network classic CLB instance.
httpCode
Int
Return code for health check of the HTTP or HTTPS listener of a public network classic CLB instance. For more information about this field, see its explanation in the CreateLoadBalancerListeners API.
httpCheckPath
String
Health check path of the HTTP or HTTPS listener of a public network classic CLB instance.
SSLMode
String
Verification method of the HTTPS listener of a public network classic CLB instance.
certId
String
Server certificate ID of the HTTPS listener of a public network classic CLB instance.
certCaId
String
Client certificate ID of the HTTPS listener of a public network classic CLB instance.
status
Int
Listener status. 0: creating; 1: running.

Example

Request
https://lb.api.qcloud.com/v2/index.php?Action=DescribeLoadBalancerListeners
&loadBalancerId=lb-abcdefgh
&listenerIds.0=lbl-6hkiqc6c
&listenerIds.1=lbl-6wv071ba
Response
{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "listenerSet": [
        {	
            "listenerId": "lbl-6hkiqc6c",
            "loadBalancerPort": 80,
            "instancePort": 80,
            "protocol": 4,
            "status": 1,
            "listenerName": "teaa",
            "unListenerId": "lbl-6hkiqc6c",
            "sessionExpire": 1000,
            "healthSwitch": 1,
            "timeOut": 6,
            "intervalTime": 6,
            "healthNum": 3,
            "unhealthNum": 3,
            "httpCode": 15,
            "httpCheckPath": "/",
            "httpHash": "ip_hash",
            "SSLMode": "mutual",
            "certId": "4b9fc92b",
            "certCaId": "ee4c5590"
        },
        {
            "listenerId": "lbl-6hkiqc6c",
            "loadBalancerPort": 777,
            "instancePort": 798,
            "protocol": 4,
            "status": 1,
            "listenerName": "",
            "unListenerId": "lbl-6wv071ba",
            "sessionExpire": 0,
            "healthSwitch": 1,
            "timeOut": 2,
            "intervalTime": 5,
            "healthNum": 3,
            "unhealthNum": 3,
            "httpCode": 31,
            "httpCheckPath": "/",
            "httpHash": "wrr",
            "SSLMode": "mutual",
            "certId": "e2b6d555",
            "certCaId": "dcda0a22"
        }
    ],
    "totalCount": 2
}


이전 주제: ModifyLoadBalancerListener다음 주제: RegisterInstancesWithLoadBalancer

도움말 및 지원

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

피드백