tencent cloud

Cloud Load Balancer

動向とお知らせ
製品アップデート情報
製品に関するお知らせ
製品の説明
製品概要
製品の優位性
ユースケース
技術原理
Product Comparison
使用上の制約
Service Regions and Service Providers
購入ガイド
課金概要
課金項目
購入方法
支払い延滞の説明
製品属性の選択
クイックスタート
ドメイン名型CLBクイックスタート
CLBクイックスタート
IPv6 CLBクイックスタート
CentOSにおけるNginxのデプロイ
CentOSにおけるJava Webのデプロイ
操作ガイド
CLBインスタンス
CLBリスナー
バックエンドサーバー
ヘルスチェック
証明書管理
ログ管理
監視アラート
Cloud Access Management
従来型CLB
プラクティスチュートリアル
証明書をCLBに配置(双方向認証)
CLBのGzip有効化設定およびチェック方法の説明
HTTPS転送設定スタートガイド
クライアントリアルIPの取得方法
ロードバランサーのモニタリングアラート設定のベストプラクティス
マルチアベイラビリティーゾーンの高可用性設定の説明
バランシングアルゴリズムの選択と重みの設定の例
CLBのリスニングドメイン名に対してWebセキュリティ保護を実行するようにWAFを設定する
メンテナンスガイド
クライアントのtimewaitが多すぎる場合の対処方法
CLBのHTTPSサービスパフォーマンステスト
ストレステストに関するよくあるご質問
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
よくあるご質問
課金関連
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
}


ヘルプとサポート

この記事はお役に立ちましたか?

フィードバック