调用 DescribeLoadBalancers 接口，查询满足指定条件的CLB实例。

使用说明

传入多个请求参数，按照传入的参数进行查询，返回符合所有条件的CLB实例，若没有符合条件的CLB实例，则返回空值。

若请求参数非必选参数均未传入，则按照当前登录账号查询，返回当前账号下的所有CLB实例。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

Action String 必选示例值：DescribeLoadBalancers

要执行的操作，取值：DescribeLoadBalancers。

Version String 必选示例值：2020-04-01

API的版本信息，当前版本为 2020-04-01。

ExclusiveClusterId String 可选示例值：ec-bp1o94dp5i6ea****

独占集群的ID。

您可以调用DescribeExclusiveClusters接口，查询独占集群的ID。

说明

独占集群正在邀测中，暂仅支持完成企业认证的账号申请试用，如需试用，请联系客户经理。

LoadBalancerName String 可选示例值：clb-test

CLB实例的名称。

LoadBalancerIds.N String 可选示例值：clb-bp1b6c719dfa08ex****

CLB实例的ID。

参数 - N：表示CLB实例ID的序号，取值范围：1 ～ 20。

多个CLB实例ID之间用&分隔。

InstanceIds.N String 可选示例值：eni-2feo5qd3orri85oxruvxv***

CLB的后端服务器的ID。

参数 - N：表示后端服务器ID的序号，取值范围为1 ～ 20。

多个后端服务器ID之间用&分隔。

InstanceIps.N String 可选示例值：192.168.1.66

CLB的后端服务器的IP地址。

参数 - N：表示后端服务器IP的序号，取值范围为1 ～ 20。

多个后端服务器IP地址之间用&分隔。

MasterZoneId String 可选示例值：cn-shanghai-a

CLB实例的主可用区ID。

您可以调用DescribeZones接口，查询主可用区ID。

AddressIpVersion String 可选示例值：ipv4

CLB实例的IP地址类型。取值如下：

ipv4：仅IPv4。

DualStack：双栈，即IPv4和IPv6。

说明

双栈CLB功能正在邀测中，如需试用，请联系客户经理。

Type String 可选示例值：private

CLB实例的网络类型。

public：公网。

private：私网。

VpcId String 可选示例值：vpc-13fd2oy7dsiyo3n6nu4ye****

CLB实例所属的VPC ID。

您可以调用DescribeVpcs接口，查询VPC的ID。

EniAddress String 可选示例值：192.XX.XX.06

CLB实例的私网IPv4地址。

您可以调用DescribeLoadBalancerAttributes接口，查询CLB实例的私网IPv4地址。

EipAddress String 可选示例值：10.XX.XX.4

CLB实例绑定公网IP的地址。

您可以调用DescribeEipAddresses接口，查询CLB实例的公网IP地址。

Status String 可选示例值：Active

CLB实例状态。取值如下：

Inactive：已停止。

Active：运行中。

Creating：创建中。

Provisioning：创建中。

Configuring：配置中。

Deleting：删除中。

CreateFailed：创建失败。

ProjectName String 可选示例值：default

CLB实例所属项目的名称。

TagFilters.N.Key String 可选示例值：k1

标签的标签键。

参数 - N：表示标签键的序号，取值范围：1～10。

多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与（AND）”，即查询同时添加多个标签键的CLB实例。

不允许重复。

TagFilters.N.Values.N String 可选示例值：v1

标签的标签值。

第一个N：表示标签键的序号，取值范围：1～10。

第二个N：表示标签值的序号，取值范围：1～3。同一标签键多个标签值之间的关系为逻辑“或(OR)”，即查询同一标签键下添加其中一个标签值的CLB实例。

多个标签值之间用&分隔。

说明

若传入该参数，则必须先传入TagFilters.N.Key。

传入空字符串时，表示查询标签值为空的CLB实例。

PageNumber Integer 可选示例值：1

列表的页码，默认值为1。

PageSize Integer 可选示例值：10

分页查询时每页的行数，取值范围：1 ~ 100 ，默认值为10。

返回参数

RequestId String 示例值：202108161106382514606306AF947C****

请求ID。

TotalCount Integer 示例值：50

符合条件的实例总数。

PageNumber Integer 示例值：1

当前页码。

PageSize Integer 示例值：10

当前分页的行数。

LoadBalancers Object[] 示例值：--

符合条件的CLB实例的详细信息。

ExclusiveClusterId String 示例值：ec-bp1o94dp5i6ea****

独占集群的ID。

非独占集群类型的CLB实例该参数返回为空。

AccountId String 示例值：210012****

CLB实例所属的账号ID。

LoadBalancerId String 示例值：clb-bp1o94dp5i6ea****

CLB实例ID。

LoadBalancerName String 示例值：clb-test

CLB实例的名称。

Description String 示例值：测试实例

CLB实例的描述。

Type String 示例值：private

CLB实例的类型。

AddressIpVersion String 示例值：ipv4

CLB实例的IP地址类型。

LoadBalancerBillingType Integer 示例值：2

CLB实例的计费方式。

1：包年包月

2：按量计费-按规格计费

3：按量计费-按使用量计费

说明

按使用量计费正在邀测中，如需试用，请联系客户经理。

LoadBalancerSpec String 示例值：small_1

CLB实例的规格。

参数LoadBalancerBillingType返回为3时，该参数返回为空。

MasterZoneId String 示例值：cn-shanghai-a

CLB实例的主可用区ID。

SlaveZoneId String 示例值：cn-shanghai-b

CLB实例的备可用区ID。

CLB实例为单可用区实例时，该参数返回为空。

VpcId String 示例值：vpc-bp1aevy8sofi8mh1****

CLB实例所属的VPC ID。

SubnetId String 示例值：subnet-bp12mw1f8k3jgy****

CLB实例所属的子网ID。

EniID String 示例值：eni-2fe6rabqt8gxruv8u8c9f****

CLB实例占用的网卡ID。

EniAddress String 示例值：172.XX.XX.33

CLB实例的私网IPv4地址。

EniAddressNum Integer 示例值：2

CLB实例的私网IPv4地址数量。

说明

本参数正在邀测中，如需试用，请联系客户经理。

EniAddresses Object[] 示例值：--

CLB实例的私网IPv4地址信息。

说明

本参数正在邀测中，如需试用，请联系客户经理。

EniAddress String 示例值：172.XX.XX.33

CLB实例的私网IPv4地址。

EipId String 示例值：eip-3ciyamhu46c6rrswwusg****

私网IPv4地址绑定的公网IP的ID。

EipAddress String 示例值：10.XX.XX.27

私网IPv4地址绑定的公网IP地址。

EipID String 示例值：eip-3ciyamhu46c6rrswwusg****

CLB实例绑定的公网IP ID。

EipAddress String 示例值：10.XX.XX.27

CLB实例的公网IP地址。

EniIpv6Address String 示例值：2408:4005:XX:XX:200

CLB实例的私网IPv6地址。

Ipv6EipId String 示例值：eip-2zaiwb7ujxscd****

IPv6公网带宽的ID。

ModificationProtectionStatus String 示例值：ConsoleProtection

CLB实例是否开启控制台上修改保护。

开启后，禁止通过控制台修改实例或删除实例。

NonProtection或空：不开启。

ConsoleProtection：开启。

ModificationProtectionReason String 示例值：托管实例

设置修改保护状态的原因。

仅参数ModificationProtectionStatus取ConsoleProtection时，本参数有效。

ServiceManaged Boolean 示例值：true

CLB实例是否为托管资源。

true：托管资源。表示创建CLB以外的其他云资源时系统同步创建的CLB资源。

false：非托管资源。表示在CLB侧手动创建的CLB资源。

Status String 示例值：Active

CLB实例状态。

BusinessStatus String 示例值：FinancialLocked

CLB实例是否被锁定。

Normal: 正常。

FinancialLocked: 被锁定。

该参数返回为空时，表示实例未被锁定。

LockReason String 示例值：Financial

CLB实例被锁定的原因。

Financial: 因欠费被锁定。

当参数BusinessStatus为“Normal”或空值时，本参数返回为空。

ProjectName String 示例值：default

CLB实例所属项目的名称。

Tags Object[] 示例值：--

CLB实例的标签信息。

Key String 示例值：k1

标签的标签键。

Value String 示例值：v1

标签的标签值。

BypassSecurityGroupEnabled String 示例值：off

CLB实例是否开启了“放通后端安全组”功能。

on：开启。

off：未开启。

说明

本功能正在邀测中，如需试用，请联系客户经理。

TimestampRemoveEnabled String 示例值：off

是否开启清除TCP/HTTP/HTTPS报文的timestamp（即时间戳）的功能。

on：开启。

off：不开启。

说明

本功能正在邀测中，如需试用，请联系客户经理。

CreateTime String 示例值：2021-08-11T16:37:37Z

CLB实例的创建时间。

UpdateTime String 示例值：2021-08-11T16:37:37Z

CLB实例的最近操作时间。

OverdueTime String 示例值：2021-08-11T16:37:37Z

CLB实例被冻结的时间。

参数BusinessStatus为“Normal”或空值时，本参数返回为空。

DeletedTime String 示例值：2021-08-11T16:37:37Z

CLB实例的预期回收时间。

ExpiredTime String 示例值：2021-08-11T23:59:59Z

CLB实例到期时间。

仅参数LoadBalancerBillingType为1时，返回该参数。

请求示例

返回示例

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

状态码	错误码	错误信息	说明
400	InvalidEipAddress.Malformed	The specified EipAddress is malformed.	指定的 EipAddress 参数格式不合法。
400	InvalidEniAddress.Malformed	The specified EniAddress is malformed.	指定的 EniAddress 参数格式不合法。
400	InvalidIncorrectOrder.Malformed	The specified index order is malformed.	指定的索引顺序参数格式不合法。
400	InvalidInstanceIp.Malformed	The specified InstanceIp is malformed.	指定的 InstanceIp 参数格式不合法。
400	InvalidName.Malformed	The specified Name is malformed.	指定的 Name 参数格式不合法。
400	InvalidPageNumber.Malformed	The specified PageNumber is malformed.	指定的 PageNumber 参数格式不合法。
400	InvalidPageSize.Malformed	The specified PageSize is malformed.	指定的 PageSize 参数格式不合法。
400	InvalidPaging.Malformed	The specified PageNumber or PageSize is malformed.	指定的分页参数格式不合法。
400	InvalidTagKey.Malformed	The specified TagKey is malformed.	指定的 TagKey 参数格式不合法。
400	InvalidTagValue.Malformed	The specified TagValue is malformed.	指定的 TagValue 参数格式不合法。
400	LimitExceeded.LoadBalancerIdNumber	You've reached the limit on the number of description LoadBalancer that you can operate.	已达到单次可查询负载均衡的数量上限。
400	LimitExceeded.ServerInstanceIdNumber	You've reached the limit on the number of description ServerInstanceId that you can operate.	已达到单次可查询服务器 ID 的数量上限。
400	LimitExceeded.ServerInstanceIpNumber	You've reached the limit on the number of description ServerInstanceIp that you can operate.	已达到单次可查询服务器 IP 的数量上限。
400	LimitExceeded.TagFilterKey	You've reached the limit on the number of tag keys that you can filter.	已达到单次可指定过滤标签键数量的上限。
400	LimitExceeded.TagFilterValues	You've reached the limit on the number of tag values that you can filter.	已达到单次可指定过滤标签键值数量的上限。
400	MissingParameter	The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, the ''.	该请求缺少必要参数。请确保发起请求已提供全部必要参数，比如。
500	InternalError	An internal error has occurred.	发生内部错误。

负载均衡