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 프로토콜 지원
연락처
용어집

DescribeLoadBalancers

PDF
포커스 모드
폰트 크기
마지막 업데이트 시간: 2024-12-19 14:28:25

API Description

This API is used to obtain the list of CLB instances and output satisfactory CLB instances based on the specified parameters.
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 DescribeLoadBalancers.
Parameter
Required
Type
Description
loadBalancerIds.n
No
String
CLB instance ID.
loadBalancerType
No
Int
Network type of the CLB instance.
2: public network; 3: private network.
forward
No
Int
CLB instance type. 1: CLB; 0: classic CLB, -1: all.
loadBalancerName
No
String
CLB instance name.
domain
No
String
Domain name assigned to a public network classic CLB instance by Tencent Cloud. This field is inapplicable to other types of CLB instances.
loadBalancerVips.n
No
String
VIP address of the CLB instance. You can enter several VIP addresses.
backendWanIps.n
No
String
Public IP of the real server bound to a CLB instance.
backendLanIps.n
No
String
Private IP of the real server bound to a CLB instance.
offset
No
Int
Data offset. Default value: 0.
limit
No
Int
Number of returned CLB instances. Default value: 20.
orderBy
No
String
Sort by field. Valid values: loadBalancerName, createTime, domain, loadBalancerType.
orderTyp
No
Int
1: reverse; 0: sequential. The createTime in reverse chronological order will be used by default.
searchKey
No
String
Search field which fuzzy matches name, domain name, or VIP.
projectId
No
Int
ID of the project to which a CLB instance belongs, which can be obtained via the DescribeProject API.
withRs
No
Int
Whether the CLB instance you want to query is bound to a real server. 0: no; 1: yes; 2: query all.

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 instances that meet the filter criteria.
loadBalancerSet
Array
Array of returned CLB instances.
loadBalancerSet structure
Parameter
Type
Description
loadBalancerId
String
CLB instance ID.
unLoadBalancerId
String
CLB instance ID.
loadBalancerName
String
CLB instance name.
loadBalancerType
Int
Network type of the CLB instance.
2: public network; 3: private network.
forward
Int
CLB type identifier. 1: CLB; 0: classic CLB.
domain
String
Domain name assigned to a public network classic CLB instance by Tencent Cloud. This field is inapplicable to other types of CLB instances.
loadBalancerVips
Array
VIP list of the CLB instance.
status
Int
Status of the CLB instance.
0: creating; 1: running.
createTime
String
Creation time of the CLB instance.
statusTime
String
Last time when the status of the CLB instance changes.
projectId
Int
ID of the project to which the CLB instance belongs. 0: default project.
vpcId
Int
Numerical digits of the VPC ID. 0: classic network.
subnetId
Int
Numerical digits of the VPC subnet ID. 0: default subnet.
openBgp
Int
Identifier of a high defense LB. 1: high defense CLB; 0: non-high defense CLB.
snat
Bool
"snat" is enabled for all private network classic CLB instances created before December 2016.
isolation
Int
Isolation status of the CLB instance due to account arrears. 0: not isolated; 1: isolated.
log
String
Log information. Only the public network CLB instances that have HTTP or HTTPS listener can generate logs.

Example

Querying the CLB instance list using default parameters
https://lb.api.qcloud.com/v2/index.php?Action=DescribeLoadBalancers
&<Common request parameters>
&forward=-1
Response
{
"code": 0,
"message": "",
"codeDesc": "Success",
"loadBalancerSet": [
{
"loadBalancerId": "lb-hc1vni0f",
"unLoadBalancerId": "lb-hc1vni0f",
"loadBalancerName": "cls-qbesvs66_ng1",
"loadBalancerType": 2,
"domain": "cls-qbesvs66-ng1.gz.1251707795.clb.myqcloud.com",
"loadBalancerVips": [
"111.230.83.36"
],
"status": 1,
"createTime": "2017-11-30 14:28:45",
"statusTime": "2017-11-30 14:29:11",
"vpcId": 2968,
"uniqVpcId": "vpc-b2h3xykt",
"subnetId": 1,
"projectId": 0,
"forward": 0,
"snat": false,
"openBgp": 0,
"isolation": 0,
"log": ""
}
],
"totalCount": 1
}


도움말 및 지원

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

피드백