文档首页

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeLoadBalancers
Version	是	否	String	公共参数，本接口取值：2018-03-17
Region	是	否	String	公共参数，详见产品支持的地域列表(TODO)
LoadBalancerIds	否	否	Array of String	负载均衡实例 ID。
LoadBalancerType	否	否	String	负载均衡实例的网络类型：<br>OPEN：公网属性， INTERNAL：内网属性。
Forward	否	否	Int64	负载均衡实例的类型。1：通用的负载均衡实例，0：传统型负载均衡实例。如果不传此参数，则查询所有类型的负载均衡实例。
LoadBalancerName	否	否	String	负载均衡实例的名称。
Domain	否	否	String	腾讯云为负载均衡实例分配的域名，本参数仅对传统型公网负载均衡才有意义。
LoadBalancerVips	否	否	Array of String	负载均衡实例的 VIP 地址，支持多个。
BackendPublicIps	否	否	Array of String	负载均衡绑定的后端服务的外网 IP。
BackendPrivateIps	否	否	Array of String	负载均衡绑定的后端服务的内网 IP。
Offset	否	否	Int64	数据偏移量，默认为 0。
Limit	否	否	Int64	返回负载均衡实例的数量，默认为20，最大值为100。
OrderBy	否	否	String	排序参数，支持以下字段：LoadBalancerName，CreateTime，Domain，LoadBalancerType。
OrderType	否	否	Int64	1：倒序，0：顺序，默认按照创建时间倒序。
SearchKey	否	否	String	搜索字段，模糊匹配名称、域名、VIP。
ProjectId	否	否	Int64	负载均衡实例所属的项目 ID，可以通过 DescribeProject 接口获取。
WithRs	否	否	Int64	负载均衡是否绑定后端服务，0：没有绑定后端服务，1：绑定后端服务，-1：查询全部。
VpcId	否	否	String	负载均衡实例所属私有网络唯一ID，如 vpc-bhqkbhdx，<br>基础网络可传入'0'。
SecurityGroup	否	否	String	安全组ID，如 sg-m1cc9123
MasterZone	否	否	String	主可用区ID，如："100001" （对应的是广州一区）
Filters	否	否	Array of Filter	此参数对外不可见。每次请求的`Filters`的上限为10，`Filter.Values`的上限为100。详细的过滤条件如下：<br><li> internet-charge-type - String - 是否必填：否 - （过滤条件）按照 CLB 的网络计费模式过滤，包括"BANDWIDTH_PREPAID","TRAFFIC_POSTPAID_BY_HOUR","BANDWIDTH_POSTPAID_BY_HOUR","BANDWIDTH_PACKAGE"。</li><br><li> master-zone-id - String - 是否必填：否 - （过滤条件）按照 CLB 的主可用区ID过滤，如："100001" （对应的是广州一区）。</li><br><li> tag-key - String - 是否必填：否 - （过滤条件）按照 CLB 标签的键过滤。</li>

3. 输出参数

参数名称	类型	描述
TotalCount	Uint64	满足过滤条件的负载均衡实例总数。此数值与入参中的Limit无关。
LoadBalancerSet	LoadBalancer	返回的负载均衡实例数组。
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidParameter
InvalidParameterValue
InternalError
UnauthorizedOperation
FailedOperation
InvalidParameter.FormatError
InvalidParameterValue.Length
InvalidParameterValue.InvalidFilter