文档中心

DescribeLoadBalancers

最近更新时间：2023.11.16 15:51:40

首次发布时间：2021.08.31 10:37:27

调用 DescribeLoadBalancers 接口查询负载均衡实例的列表。

调用说明

a.N.b类型的参数中，“N”表示根据标签查询资源时标签信息的序号，需按照数字顺序从1开始填写，取值范围为1～10。多个标签之间使用&分隔。

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必填	示例值	描述
Action	String	是	DescribeLoadBalancers	要执行的操作，取值为DescribeLoadBalancers。
Version	String	是	2020-04-01	API版本信息，当前版本为：2020-04-01。
PageSize	Integer	否	10	分页查询时每页的行数，取值范围：1 ~ 100 ，默认值为10。
PageNumber	Integer	否	1	列表的页码，默认值为1。
ExclusiveClusterId	String	否	ec-bp1o94dp5i6ea****	独占集群的ID。您可以调用DescribeExclusiveClusters接口获取独占集群的ID。
LoadBalancerIds.N	String	否	LoadBalancerIds.1=clb-bp1b6c719dfa08ex**&LoadBalancerIds.2=clb-2fea2u2m4qhog5oxruuoo**	负载均衡实例的ID。您可以调用本接口获取负载均衡实例ID。参数 - N：表示负载均衡实例ID的序号，取值范围为1 ～ 20，表示指定实例ID时最多可查询20个。
MasterZoneId	String	否	cn-shanghai-a	负载均衡实例的主可用区ID。您可以调用DescribeZones接口获取主可用区ID。
Status	String	否	Active	负载均衡实例状态。取值如下： Inactive：已停止。 Active：运行中。 Provisioning：创建中。 Configuring：配置中。 Deleting：删除中。 CreateFailed：创建失败。
VpcId	String	否	vpc-13fd2oy7dsiyo3n6nu4ye****	负载均衡实例所属的VPC ID。您可以调用DescribeVpcs接口获取VPC ID。
LoadBalancerName	String	否	clb-test	负载均衡实例的名称。
AddressIpVersion	String	否	ipv4	负载均衡实例的IP地址类型。取值如下： ipv4（默认值）：表示该负载均衡为Ipv4类型，仅支持转发IPv4请求。 DualStack：表示该负载均衡为双栈类型，支持转发IPv4和IPv6请求。说明双栈负载均衡功能正在邀测中，如需使用，请提交工单或联系客户经理申请。
EniAddress	String	否	192.XX.XX.06	负载均衡实例的私网IPv4地址。您可以调用本接口或DescribeLoadBalancerAttributes接口获取负载均衡实例的私网IPv4地址。
EipAddress	String	否	10.XX.XX.4	负载均衡实例关联的公网IP地址。您可以调用本接口或DescribeEipAddresses接口获取负载均衡实例的公网IP地址。
Type	String	否	private	负载均衡实例的网络类型。 public：公网。 private：私网。
ProjectName	String	否	default	CLB实例所属项目的名称。该参数不传入或传入为空时，表示查询所有的CLB实例。该参数传入不为空时，表示查询属于指定项目的CLB实例。
TagFilters.N.Key	String	否	TagFilters.1.Key=k1&TagFilters.2.Key=k2	CLB实例标签的标签键。指定多个标签键时，表示查询同时包含所有指定标签键的CLB实例。
TagFilters.N.Values.N	String	否	TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.2.Values.1=v3	CLB实例标签的标签值。每个标签键最多可指定3个标签值。未传入该参数时，表示查询指定标签键下所有标签值对应的标签所关联的CLB实例。该参数取值为空时，表示查询指定标签键下标签值为空的标签所关联的CLB实例。同一个标签键指定多个标签值时，表示查询各个标签值对应标签所关联CLB实例的集合。如果传入该参数，则必须先传入`TagFilters.N.Key`。

返回数据

名称	类型	示例值	描述
RequestId	String	202108161106382514606306AF947C****	请求ID。
AccountId	String	210012****	负载均衡实例所属的账号ID。
PageSize	Integer	10	当前分页的行数。
PageNumber	Integer	1	当前页码。
TotalCount	Integer	50	符合条件的实例总数。
LoadBalancers	Array of Struct	-	符合条件的负载均衡实例的详细信息。具体请参见下表“ LoadBalancers ”。

LoadBalancers

名称	类型	示例值	描述
ExclusiveClusterId	String	ec-bp1o94dp5i6ea****	独占集群的ID。非独占集群类型的CLB实例该参数返回为空。
LoadBalancerId	String	clb-bp1o94dp5i6ea****	负载均衡实例ID。
LoadBalancerName	String	clb-test	负载均衡实例的名称。
Status	String	Active	负载均衡实例状态。 Inactive：已停止。 Provisioning：创建中。 Configuring：配置中。 Deleting：删除中。 CreateFailed：创建失败。
Description	String	测试实例	负载均衡实例的描述。
CreateTime	String	2021-08-11T16:37:37Z	负载均衡实例的创建时间。
UpdateTime	String	2021-08-11T16:37:37Z	负载均衡实例的最近操作时间。
Type	String	private	负载均衡实例的类型。 public：表示创建一个公网负载均衡实例，系统会分配一个公网IP地址和一个私网IP地址，公网IP地址用于转发公网请求，私网IP地址用于转发私网请求。 private：表示创建一个私网负载均衡实例，系统会分配一个私网IP地址，仅用于转发私网请求。
MasterZoneId	String	cn-shanghai-a	负载均衡实例的主可用区ID。
SlaveZoneId	String	cn-shanghai-b	负载均衡实例的备可用区ID。负载均衡实例为单可用区实例时，该参数返回为空。
VpcId	String	vpc-bp1aevy8sofi8mh1****	负载均衡实例所属的VPC ID。
SubnetId	String	subnet-bp12mw1f8k3jgy****	负载均衡实例所属的子网ID。
ModificationProtectionStatus	String	ConsoleProtection	负载均衡实例的修改保护状态。 NonProtection：不开启修改保护功能，配置后会清空已配置的`ModificationProtectionReason`。 ConsoleProtection：开启控制台修改保护功能，表示禁止通过控制台修改实例或删除实例，但允许通过API接口修改或删除。
ModificationProtectionReason	String	托管实例	设置修改保护状态的原因。说明仅在参数`ModificationProtectionStatus`配置为ConsoleProtection时有效。
AddressIpVersion	String	ipv4	负载均衡实例的IP地址类型。 ipv4：表示该负载均衡为Ipv4类型，仅支持转发IPv4请求。 DualStack：表示该负载均衡为双栈类型，支持转发IPv4和IPv6请求。
EipID	String	eip-3ciyamhu46c6rrswwusg****	负载均衡实例绑定的公网IP ID。
Ipv6EipId	String	eip-2zaiwb7ujxscd****	IPv6公网带宽的ID。
EniAddress	String	172.XX.XX.33	负载均衡实例的私网IPv4地址。
EniIpv6Address	String	2408:4005:XX:XX:200	负载均衡实例的私网IPv6地址。
EniID	String	eni-2fe6rabqt8gxruv8u8c9f****	负载均衡实例占用的网卡ID。
EipAddress	String	10.XX.XX.27	负载均衡实例的公网IP地址。
BusinessStatus	String	FinancialLocked	负载均衡实例是否被锁定。 Normal: 正常。 FinancialLocked: 被锁定。说明该参数返回为空时，表示实例未被锁定。
LockReason	String	Financial	负载均衡实例被锁定的原因。 Financial: 因欠费被锁定。说明参数`BusinessStatus`取值为“Normal”或空值时，该参数返回为空。
OverdueTime	String	2021-08-11T16:37:37Z	负载均衡实例被冻结的时间。说明参数`BusinessStatus`取值为“Normal”或空值时，该参数返回为空。
DeletedTime	String	2021-08-11T16:37:37Z	负载均衡实例的预期回收时间。
ExpiredTime	String	2021-08-11T23:59:59Z	负载均衡实例到期时间。说明仅在参数`LoadBalancerBillingType`配置为1时，返回该参数。
LoadBalancerSpec	String	small_1	负载均衡实例的规格。说明参数LoadBalancerBillingType返回为3时，该参数返回为空。
LoadBalancerBillingType	Integer	2	负载均衡实例的计费类型。 1：包年包月 2：按量计费-按规格计费 3：按量计费-按使用量计费
ServiceManaged	Boolean	false	CLB实例是否为托管资源。 true：托管资源。表示创建CLB以外的其他云资源时系统同步创建的CLB资源。 false：非托管资源。表示在CLB侧手动创建的CLB资源。
ProjectName	String	default	CLB实例所属项目的名称。
Tags	Array of Struct	-	CLB实例的标签信息。具体请参见下表“Tag”。
EniAddressNum	Integer	2	负载均衡实例的私网IPv4地址数量。
EniAddresses	Array of Struct	-	负载均衡实例的私网IPv4地址信息。具体请参见下表“ EniAddresses”。

Tag

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

EniAddresses

名称	类型	示例值	描述
EniAddress	String	172.XX.XX.33	负载均衡实例的辅助私网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

返回示例

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

错误码

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

HttpCode	错误码	错误信息	描述
400	InvalidName.Malformed	The specified Name is malformed.	指定的 Name 参数格式不合法。
400	InvalidEipAddress.Malformed	The specified EipAddress is malformed.	指定的 EipAddress 参数格式不合法。
400	InvalidEniAddress.Malformed	The specified EniAddress is malformed.	指定的 EniAddress 参数格式不合法。
400	InvalidPaging.Malformed	The specified PageNumber or PageSize is malformed.	指定的分页参数格式不合法。
400	LimitExceeded.LoadBalancerNumber	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	InvalidIncorrectOrder.Malformed	The specified index order is malformed.	指定的索引顺序参数格式不合法。
400	LimitExceeded.TagFilterValues	You've reached the limit on the number of tag values that you can filter.	已达到单次可指定过滤标签键值数量的上限。
400	InvalidTagKey.Malformed	The specified TagKey is malformed.	指定的 TagKey 参数格式不合法。
400	InvalidTagValue.Malformed	The specified TagValue is malformed.	指定的 TagValue 参数格式不合法。

调用说明

调试

请求参数

返回数据

请求示例

返回示例

错误码