调用 DescribeLoadBalancers 接口，查询 ALB 实例列表。 ## 使用说明 * 每秒最多提交 200 个 API 请求。 * 传入多个请求参数，按照传入的参数进行查询，返回符合所有条件的ALB实例，若没有符合条件的ALB实例，则返回空值。 * 若请求参数非必选参数均未传入，则按照当前登录账号查询，返回当前账号下的所有ALB实例。 ## 调试 ## 请求参数下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见[公共参数](https://www.volcengine.com/docs/6369/67268)。 **Action** string %%require%% `示例值：DescribeLoadBalancers` 要执行的操作，取值：DescribeLoadBalancers。 **Version** string %%require%% `示例值：2020-04-01` API的版本，取值：2020\-04\-01。 **EniAddress** string `可选` `示例值：192.168.XX.XX` ALB 实例的私网 IP 地址。 **LoadBalancerIds.N** string[] `可选` `示例值：LoadBalancerIds.1=alb-bp1b6c719dfa08ex****&LoadBalancerIds.2=alb-2fea2u2m4qhog5oxruuoo****` ALB 实例的ID。 * 参数\-N：表示 ALB 实例ID的序号，取值范围为1 ～ 20，表示指定实例ID时最多可查询20个。 * 多个ALB实例的ID之间用&分隔。 **LoadBalancerName** string `可选` `示例值：ls-test` ALB 实例的名称。 **PageNumber** integer `可选` `示例值：1` 列表的页码，默认值为1。 **PageSize** integer `可选` `示例值：10` 分页查询时每页的行数，取值范围：1 ~ 100 ，默认值为10。 **TagFilters.N.Key** string[] `可选` `示例值：TagFilters.1.Key=k1&TagFilters.2.Key=k2` 标签的标签键。 * 参数 \- N：表示标签键的序号，取值范围：1～10。 * 多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与（AND）”，即查询同时添加多个标签键的ALB实例。 * 不允许重复。 **VpcId** string `可选` `示例值：vpc-13fd2oy7du4ye****` ALB 实例所属的 VPC ID。 **TagFilters.N.Values.N** string[] `可选` `示例值：TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2& TagFilters.2.Values.1=v3` 2标签的标签值。 * 第一个N：表示标签键的序号，取值范围：1～10。 * 第二个N：表示标签值的序号，取值范围：1～3。同一标签键多个标签值之间的关系为逻辑“或(OR)”，即查询同一标签键下添加其中一个标签值的ALB实例。 * 多个标签值之间用&分隔。 :::tip * 若传入该参数，则必须先传入TagFilters.N.Key。 * 传入空字符串时，表示查询标签值为空的ALB实例。 ::: **EipAddress** string `可选` `示例值：180.112.XX.XX` ALB 实例的公网 IP 地址。 **Type** string `可选` `示例值：public` ALB 实例的类型。取值如下： * public：公网ALB。 * private：私网ALB。 **ProjectName** string `可选` `示例值：default` 实例所属项目名称。 ## 返回参数下方仅列出本接口特有的返回参数。更多信息请参见[返回结构](https://www.volcengine.com/docs/6369/80336)。 **RequestId** string `示例值：202108111103030****` 请求ID。 **PageSize** integer `示例值：10` 当前分页的行数。 **PageNumber** integer `示例值：1` 当前页码。 **TotalCount** integer `示例值：50` 符合条件的 ALB 实例总数。 **LoadBalancers** object[] `示例值：--` 符合条件的 ALB 实例的详细信息。 **SecurityGroupIds** string[] `示例值：["sg-bp67acfmxazb4p****"]` ALB 实例关联的安全组 ID。 **LoadBalancerId** string `示例值：alb-bp1o94dp5i6ea****` ALB 实例ID。 **LoadBalancerName** string `示例值：alb-test1` ALB 实例的名称。 **AddressIpVersion** string `示例值：DualStack` ALB 实例的 IP 类型。 * IPv4：IPv4 类型。 * DualStack：IPv4&IPv6 双栈类型。 **Status** string `示例值：Active` ALB 实例状态。 * Active：运行中。 * Provisioning：创建中。 * Configuring：配置中。 * Deleting：删除中。 * CreateFailed：创建失败。 * Inactive：已停止。 **Description** string `示例值：test` ALB 实例的描述。 **CreateTime** string `示例值：2021-08-11T16:37:37Z` ALB 实例的创建时间。 **UpdateTime** string `示例值：2021-08-11T16:37:37Z` ALB 实例的最近操作时间。 **Type** string `示例值：private` ALB 实例的类型。 **VpcId** string `示例值：vpc-bp1aevy8sh1****` ALB 实例所属的VPC ID。 **SubnetId** string `示例值：subnet-bp12m3jgy****` ALB 实例所属的子网ID。 :::tip 本参数即将下线，请使用 ZoneMappings 字段。 ::: **EipId** string `示例值：eip-3ciyamrswwusg****` ALB 实例绑定的公网IP ID。 :::tip 本参数即将下线，请使用 ZoneMappings 字段。 ::: **EniAddress** string `示例值：172.XX.XX.33` ALB 实例的私网IP地址。 :::tip 本参数即将下线，请使用 ZoneMappings 字段。 ::: **EniId** string `示例值：eni-2fe6rabqt8c9f****` ALB 实例占用的网卡ID。 :::tip 本参数即将下线，请使用 ZoneMappings 字段。 ::: **EipAddress** string `示例值：10.XX.XX.27` ALB 实例的公网IP地址。 :::tip 本参数即将下线，请使用 ZoneMappings 字段。 ::: **BusinessStatus** string `示例值：FinancialLocked` ALB 实例是否被锁定。 * Normal: 正常。 * FinancialLocked: 被锁定。 **LockReason** string `示例值：Financial` ALB 实例被锁定的原因。该参数只有实例处于 FinancialLocked 状态时有返回值。 * Financial: 因欠费被锁定。 * Security: 因安全被锁定。 **OverdueTime** string `示例值：2021-08-11T16:37:37Z` ALB 实例被冻结的时间。该参数只有实例处于 FinancialLocked 状态时有返回值。 **DeletedTime** string `示例值：2021-08-11T16:37:37Z` ALB 实例的预期回收时间。该参数只有实例处于 FinancialLocked 状态时有返回值。 **LoadBalancerBillingType** integer `示例值：1` ALB 实例的计费方式。 1：按LCU计费。 **DNSName** string `示例值：alb-qwe1344.cn-beijing.volcenginealb.com` DNS域名。 **ZoneMappings** object[] `示例值：--` ALB 实例在不同可用区下的配置信息。 **ZoneId** string `示例值：cn-beijing-a` ALB 实例所处的可用区 **SubnetId** string `示例值：subnet-bp12m3jgy****` ALB 实例在该可用区的子网ID。 **LoadBalancerAddresses** object[] `示例值：--` ALB 实例在该可用区的IP地址。 **Ipv4LocalAddresses** string[] `示例值：["172.XX.XX.34","172.XX.XX.35"]` IPv4 Local 地址列表。ALB 与后端服务交互使用的地址列表。 **Ipv6LocalAddresses** string[] `示例值：["2408:4005:XX:XX:201","2408:4005:XX:XX:202"]` IPv6 Local 地址列表。ALB 与后端服务交互使用的地址列表。 **EniAddress** string `示例值：172.XX.XX.33` ALB 实例在该可用区的私网IP地址。 **EniId** string `示例值：eni-2fe6rabqt8g****` ALB 实例在该可用区占用的网卡ID。 **EipAddress** string `示例值：10.XX.XX.27` ALB 实例在该可用区的公网IP地址。 **EipId** string `示例值：eip-2fe698wsnj****` ALB 实例在该可用区的公网IP ID。 **Eip** object `示例值：--` ALB 实例在该可用区的公网IP的信息。 **ISP** string `示例值：BGP` ALB 实例上的公网IP线路类型： * BGP：BGP多线。 **EipBillingType** integer `示例值：2` 公网IP的计费方式。 * 2：按带宽上限计费。 * 3：按实际流量计费。 **Bandwidth** integer `示例值：10` 公网IP的带宽峰值，单位为Mbps。 **EipAddress** string `示例值：10.XX.XX.27` 负载均衡实例的公网IP地址。 **SecurityProtectionTypes** string[] `示例值：-` 公网IP 的防护类型。 * AntiDDoS_Enhanced：增强防护类型的公网IP，可加入到 DDoS 原生防护实例。 * 空值：基础防护类型的公网IP。 **EipType** string `示例值：anycast` ALB 实例上的公网IP类型，支持取值： * 空：公网IP。 * anycast：Anycast公网IP。 **PopLocations** object[] `示例值：-` ALB 作为Anycast公网IP的源站时，关联的接入点信息。仅绑定Anycast公网IP时有效。 **PopId** string `示例值：cn-beijing-pop` Anycast公网IP的接入点ID。 **PopName** string `示例值：北京-接入点` Anycast公网IP的接入点名称。 **AssociationMode** string `示例值：Default` ALB 作为Anycast公网IP的源站类型，仅绑定Anycast公网IP时有效。 * Default：默认模式。 * Normal：普通模式。 **EniIpv6Address** string `示例值：2408:4005:XX:XX:200` IPv4&IPv6 双栈类型的 ALB 实例，在该可用区的 IPv6 地址。 **Ipv6EipId** string `示例值：eip-2fe698wsnj****` IPv4&IPv6 双栈类型的 ALB 公网实例，在该可用区的 IPv6 公网带宽 ID。 **Ipv6Eip** object `示例值：--` IPv4&IPv6 双栈类型的 ALB 公网实例，在该可用区的 IPv6 公网带宽的信息。 **Bandwidth** integer `示例值：200` 公网ALB 实例的IPv6公网带宽的带宽上限，单位为Mbps。 **BillingType** integer `示例值：2` 公网ALB 实例的 IPv6 公网带宽的计费类型。 * 2：按量计费\-按带宽上限计费。 * 3：按量计费\-按实际流量计费。 **ISP** string `示例值：BGP` 公网ALB 实例的 IPv6 公网带宽的线路类型。 * BGP：BGP多线。 **DeleteProtection** string `示例值：off` ALB 实例的删除保护功能为开启或关闭状态。 * off：关闭。 * on：开启。 **ProjectName** string `示例值：default` 实例所属项目名称。 **Tags** object[] `示例值：-` 实例所属标签。 **Key** string `示例值：key` 用户标签的标签键。 **Value** string `示例值：value` 用户标签的标签值。 **WafProtectionEnabled** string `示例值：off` WAF 安全防护开关。 * off：关闭。 * on：开启。 **WafInstanceId** string `示例值：waf-14ca6f67c09****` ALB 实例绑定的 WAF 安全防护实例 ID。 **ModificationProtectionStatus** string `示例值：NonProtection` 是否启用了实例修改保护功能。 * NonProtection：未启用。 * ConsoleProtection：已启用。 **ModificationProtectionReason** string `示例值：This is modification protection` 启用实例修改保护的原因。 **LoadBalancerEdition** string `示例值：Standard` ALB 实例的版本。 * Basic：基础版。 * Standard：标准版。 **SniAutoMatch** string 实例下的监听器支持自动选择扩展证书。 **LocalAddresses** string[] `示例值：["100.64.1.0/20", "xxx"]` ALB 实例的回源地址。 **ProxyProtocolEnabled** string `示例值：off` ALB 可支持 Proxy Protocol 协议并记录客户端真实 IP。 ## 请求示例 ```text GET /?Action=DescribeLoadBalancers&Version=2020-04-01&PageSize=10&PageNumber=1&LoadBalancerIds.N=LoadBalancerIds.1=alb-bp1b6c719dfa08ex****&LoadBalancerIds.2=alb-2fea2u2m4qhog5oxruuoo****&VpcId=vpc-13fd2oy7du4ye****&LoadBalancerName=ls-test&EniAddress=192.168.XX.XX&EipAddress=180.112.XX.XX&ProjectName=default&TagFilters.1.Key=k1&TagFilters.2.Key=k2&TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2 TagFilters.2.Values.1=v3 HTTP/1.1 Host: alb.cn-beijing.volcengineapi.com ``` ## 返回示例 ```json { "ResponseMetadata": { "RequestId": "20210816110638****2514606306AF947C", "Action": "DescribeLoadBalancers", "Version": "2020-04-01", "Service": "alb", "Region": "cn-beijing" }, "Result": { "RequestId": "2021081117061401****2431470319AF3B", "PageNumber": 1, "PageSize": 2, "TotalCount": 21, "LoadBalancers": [ { "LoadBalancerId": "alb-1g1f19vdq5****ibuxyek20wz", "LoadBalancerName": "test", "Status": "Active", "Description": "test ", "CreateTime": "2021-08-11T16:37:37Z", "UpdateTime": "2021-08-11T16:37:41Z", "Type": "public", "VpcId": "vpc-2fe624a318b****xruuoxjjug", "SubnetId": "subnet-2fe6iau****ls5oxruuyfo0dd", "EipID": "eip-1g1f19xc****c8ibuxy91k9rc", "EipAddress": "10.XX.XX.217", "EniID": "eni-2fe6rx****xc5oxruvejddd5", "EniAddress": "192.XX.XX.44", "BusinessStatus": "", "LockReason": "", "OverdueTime": "", "DeletedTime": "", "LoadBalancerBillingType": 2, "DNSName": "alb-t5aepy8j5****jdjavoc2c.cn-beijing.volcalb.com", "ZoneMappings": [ { "ZoneId": "cn-beijing-a", "SubnetId": "subnet-274tv****duyo7fap8sc658ze", "LoadBalancerAddresses": [ { "EniAddress": "192.168.0.25", "EniId": "eni-274js****2xhc7fap8ssed7qg", "EipAddress": "", "EipId": "", "Eip": null } ] }, { "ZoneId": "cn-beijing-b", "SubnetId": "subnet-274up****b8xs7fap8t1odh1n", "LoadBalancerAddresses": [ { "EniAddress": "192.168.1.254", "EniId": "eni-274js****6zgg7fap8t05movj", "EipAddress": "", "EipId": "", "Eip": null } ] } ] }, } } ``` ## 错误码下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见[公共错误码](https://www.volcengine.com/docs/6369/68677)文档。 |状态码 |错误码 |错误信息 |说明 | |---|---|---|---| |400 |Invalid%s.Malformed |MismatchThe specified %s is malformed. |指定的 %s 参数格式不合法。 | |400 |MissingParameter |The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, '%s'. |该请求缺少必要参数。请确保发起请求已提供全部必要参数，比如: %s。 | |400 |InvalidParameter |Data unmarshal failed. |请求解析失败。 | |400 |InvalidPaging.Malformed |The specified PageNumber or PageSize is malformed. |指定的分页参数格式不合法。 | |400 |InvalidLoadBalancerName.Malformed |The specified LoadBalancerName is malformed. |指定的 LoadBalancerName 参数格式不合法。 | |400 |InvalidEniAddress.Malformed |The specified EniAddress is malformed. |指定的 EniAddress 参数格式不合法。 | |400 |LimitExceed.LoadBalancer |You've reached the limit on the number of loadbalancers that you can operate at a time. |已达到单次可操作的 ALB 实例的数量上限。 | |400 |LimitExceed.TagFilters.Values |You've reached the limit on the number of tag filter values that you can operate at a time. |已达到单次可操作的标签值的数量上限。 | |400 |LimitExceed.TagFilters |You've reached the limit on the number of tag filters that you can operate at a time. |已达到单次可操作的标签过滤条件的数量上限。 | |400 |InvalidTagFilters.Key.Malformed |The specified TagFilters.Key is malformed. |指定的 TagFilters.Key 参数格式不合法。 | |400 |InvalidTags.Value.Malformed |The specified Tags.Value is malformed. |指定的 Tags.Value 参数格式不合法。 | |400 |InvalidTags.Key.Duplicated |The specified Tags.Key is duplicated. |指定的 Tags.Key 重复。 | |400 |InvalidEipAddress.Malformed |The specified EipAddress is malformed. |指定的 EipAddress 参数格式不合法。 | |500 |InternalError |An internal error has occurred. |发生内部错误。请稍后重试或联系工程师进一步咨询。 |