DescribeLoadBalancers--负载均衡-火山引擎

文档中心

立即注册

导航

DescribeLoadBalancers

最近更新时间：2024.10.21 14:06:24首次发布时间：2021.08.31 10:37:27

调用 DescribeLoadBalancers 接口，查询满足指定条件的负载均衡实例。

调用说明

传入多个请求参数，按照传入的参数进行查询，返回符合所有条件的负载均衡，若没有符合条件的负载均衡，则返回空值。
若请求参数非必选参数均未传入，则按照当前登录账号查询，返回当前账号下的所有负载均衡。

调试

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	否	LoadBalancerIds.1=clb-bp1b6c719dfa08ex**&LoadBalancerIds.2=clb-2fea2u2m4qhog5oxruuoo**	CLB实例的ID。参数 - N：表示CLB实例ID的序号，取值范围：1 ～ 20。多个CLB实例ID之间用&分隔。
MasterZoneId	String	否	cn-shanghai-a	CLB实例的主可用区ID。您可以调用DescribeZones接口，查询主可用区ID。
AddressIpVersion	String	否	ipv4	CLB实例的IP地址类型。取值如下： ipv4：仅IPv4。 DualStack：双栈，即IPv4和IPv6。说明双栈负载均衡功能正在邀测中，暂仅支持完成企业认证的账号申请试用，如需试用，请联系客户经理。
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	否	TagFilters.1.Key=k1&TagFilters.2.Key=k2&TagFilters.3.Key=k3	标签的标签键。参数 - N：表示标签键的序号，取值范围：1～10。多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与（AND）”，即查询同时添加多个标签键的CLB实例。不允许重复。
TagFilters.N.Values.N	String	否	TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.3.Values.1=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	Array of Struct	-	符合条件的CLB实例的详细信息。具体请参见下表“ LoadBalancers ”。

LoadBalancers

名称	类型	示例值	描述
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	Array of Struct	-	CLB实例的私网IPv4地址信息。具体请参见下表“ EniAddresses”。说明本参数正在邀测中，暂仅支持完成企业认证的账号申请试用，如需试用，请联系客户经理。
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	false	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	Array of Struct	-	CLB实例的标签信息。具体请参见下表“Tag”。
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时，返回该参数。

Tag

名称	类型	示例值	描述
Key	String	k1	标签的标签键。
Value	String	v1	标签的标签值。

EniAddresses

名称	类型	示例值	描述
EniAddress	String	172.XX.XX.33	CLB实例的私网IPv4地址。
EipId	String	eip-3ciyamhu46c6rrswwusg****	私网IPv4地址绑定的公网IP的ID。
EipAddress	String	10.XX.XX.27	私网IPv4地址绑定的公网IP地址。

请求示例

GET /?Action=DescribeLoadBalancers&Version=2020-04-01&LoadBalancerId=clb-bp1b6c719dfa08ex****&PageNumber=1&PageSize=10&VpcId=vpc-13fd2oy7dsiyo3n6nu4ye**** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-shanghai
Service: clb

返回示例

```json
{
    "ResponseMetadata": {
        "RequestId": "202108161106382514606306AF947C****",
        "Action": "DescribeLoadBalancers",
        "Version": "2020-04-01",
        "Service": "clb",
        "Region": "cn-shanghai"
    },   
    "Result": {
        "RequestId": "202108161106382514606306AF947C****",
        "TotalCount": 21,
        "PageNumber": 1,
        "PageSize": 2,
        "LoadBalancers": [
            {
                "ExclusiveClusterId": "",
                "AccountId": "210012****",
                "LoadBalancerId": "clb-bp1o94dp5i6ea****",
                "LoadBalancerName": "clb-test",
                "Description": "测试实例",
                "Type": "public",
                "AddressIpVersion": "ipv4",
                "LoadBalancerBillingType": 2,
                "LoadBalancerSpec": "small_1",
                "MasterZoneId": "cn-shanghai-a",
                "SlaveZoneId": "cn-shanghai-b",
                "VpcId": "vpc-13fd2oy7dsiyo3n6nu4ye****",
                "SubnetId": "subnet-bp12mw1f8k3jgy****",
                "EniID": "eni-2fe6rabqt8gxruv8u8c9f****",
                "EniAddress": "192.XX.XX.44",
                "EipID": "eip-3ciyamhu46c6rrswwusg****",
                "EipAddress": "10.XX.XX.27",
                "EniIpv6Address": "2408:4005:XX:XX:200",
                "Ipv6EipId": "eip-2zaiwb7ujxscd****",
                "ModificationProtectionStatus": "ConsoleProtection",
                "ModificationProtectionReason": "",
                "ServiceManaged": false,
                "Status": "Active",
                "BusinessStatus": "",
                "LockReason": "",
                "ProjectName": "default",
                "Tags": [
                    {
                       "Key": "k1",
                        "Value": "v1"
                    },
                    {
                        "Key": "k2",
                        "Value": ""
                    }
                ],
                "CreateTime": "2021-08-11T16:37:37Z",
                "UpdateTime": "2021-08-11T16:37:41Z",
                "OverdueTime": "",
                "DeletedTime": ""
            }
      }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HttpCode	错误码	错误信息	描述
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	InvalidName.Malformed	The specified Name is malformed.	指定的 Name 参数格式不合法。
400	InvalidPaging.Malformed	The specified PageNumber or PageSize is malformed.	指定的分页参数格式不合法。
400	InvalidParameter	Data unmarshal failed.	请求解析失败。
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.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.	已达到单次可指定过滤标签键值数量的上限。