文档中心

DescribeLoadBalancers

最近更新时间：2024.02.29 14:48:16

首次发布时间：2022.05.20 21:48:57

API 说明

API 名称：DescribeLoadBalancers
API 域名：open.volcengineapi.com 。
API 描述：查询 ALB 实例列表。

使用限制

节流限制：每秒最多提交 200 个 API 请求。

快速调试

API Explorer

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

去调试

URI 参数

在使用该部分 API 提交请求时必须包含以下 URI 参数。

除了 URI 参数，该 API 请求还需要包含签名参数。关于更多签名参数的信息，参见公共请求参数。

名称	类型	是否必选	格式	说明
Action	string	是	[a-zA-Z]+	API 名称，如 DescribeLoadBalancers 。
Version	string	是	YYYY-MM-DD	API 版本信息。该参数的取值是 2020-04-01 。
X-Expires	int	否	900	表示签名的有效时间，单位是秒，默认值是900。

请求正文

在使用该 API 提交请求时，请求正文中可以包含的参数如下。

参数	类型	是否必选	参数说明	示例
PageSize	Integer	否	分页查询时每页的行数，取值范围：1 ~ 100 ，默认值为10。	10
PageNumber	Integer	否	列表的页码，默认值为1。	1
LoadBalancerIds.N	List of String	否	ALB 实例的ID。 - N：表示 ALB 实例ID的序号，取值范围为1 ～ 20，表示指定实例ID时最多可查询20个。	LoadBalancerIds.1=alb-bp1b6c719dfa08ex**&LoadBalancerIds.2=alb-2fea2u2m4qhog5oxruuoo**
VpcId	String	否	ALB 实例所属的 VPC ID。	vpc-13fd2oy7dsiyo3n6nu4ye****
LoadBalancerName	String	否	ALB 实例的名称。	ls-test
EniAddress	String	否	ALB 实例的私网 IP 地址。	192.168.XX.XX
EipAddress	String	否	ALB 实例的公网 IP 地址。	180.112.XX.XX
ProjectName	String	否	实例所属项目名称。	default
TagFilters	Array	否	实例所属标签，具体参见下表 TagFilters。	-

TagFilters

参数	类型	是否必选	参数说明	示例
TagFilters.N.Key	String	否	ALB实例标签的标签键。指定多个标签键时，表示查询同时包含所有指定标签键的ALB实例。	TagFilters.1.Key=k1&TagFilters.2.Key=k2
TagFilters.N.Values.N	String	否	ALB实例标签的标签值。如果传入该参数，则必须先传入TagFilters.N.Key。具体规则如下：每个标签键最多可指定3个标签值。同一个标签键指定多个标签值时，表示查询各个标签值对应标签所关联ALB实例的集合。未传入该参数时，表示查询指定标签键下所有标签值对应的标签所关联的ALB实例。该参数取值为空时，表示查询指定标签键下标签值为空的标签所关联的ALB实例。	TagFilters.1.Value.1=v1&TagFilters.1.Value.2=v2&TagFilters.2.Value.1=v3

参数

类型

是否必选

参数说明

示例

TagFilters.N.Key

String

否

ALB实例标签的标签键。指定多个标签键时，表示查询同时包含所有指定标签键的ALB实例。

TagFilters.1.Key=k1&TagFilters.2.Key=k2

TagFilters.N.Values.N

String

否

ALB实例标签的标签值。如果传入该参数，则必须先传入TagFilters.N.Key。具体规则如下：

每个标签键最多可指定3个标签值。
同一个标签键指定多个标签值时，表示查询各个标签值对应标签所关联ALB实例的集合。
未传入该参数时，表示查询指定标签键下所有标签值对应的标签所关联的ALB实例。
该参数取值为空时，表示查询指定标签键下标签值为空的标签所关联的ALB实例。

TagFilters.1.Value.1=v1&TagFilters.1.Value.2=v2&TagFilters.2.Value.1=v3

响应正文

参数	类型	参数说明	示例值
RequestId	String	请求ID。	20210811152539010225146063030****
PageSize	Integer	当前分页的行数。	10
PageNumber	Integer	当前页码。	1
TotalCount	Integer	符合条件的 ALB 实例总数。	50
LoadBalancers	Array	符合条件的 ALB 实例的详细信息。具体参见下表LoadBalancers。	-

LoadBalancers

参数	类型	参数说明	示例值
LoadBalancerId	String	ALB 实例ID。	alb-bp1o94dp5i6ea****
LoadBalancerName	String	ALB 实例的名称。	alb-test1
AddressIpVersion	String	ALB 实例的 IP 类型。取值如下： IPv4：IPv4 类型。 DualStack：IPv4&IPv6 双栈类型。	DualStack
Status	String	ALB 实例状态。 Active：运行中。 Provisioning：创建中。 Configuring：配置中。 Deleting：删除中。 CreateFailed：创建失败。 Inactive：已停止。	Active
Description	String	ALB 实例的描述。	测试实例
CreateTime	String	ALB 实例的创建时间。	2021-08-11T16:37:37Z
UpdateTime	String	ALB 实例的最近操作时间。	2021-08-11T16:37:37Z
Type	String	ALB 实例的类型。 public：表示创建一个公网 ALB 实例，系统会分配一个公网IP地址和一个私网IP地址，公网IP地址用于转发公网请求，私网IP地址用于转发私网请求。 private：表示创建一个私网负载均衡实例，系统会分配一个私网IP地址，仅用于转发私网请求。	private
VpcId	String	ALB 实例所属的VPC ID。	vpc-bp1aevy8sofi8mh1****
SubnetId（即将下线）	String	ALB 实例所属的子网ID。	subnet-bp12mw1f8k3jgy****
EipId（即将下线）	String	ALB 实例绑定的公网IP ID。	eip-3ciyamhu46c6rrswwusg****
EniAddress（即将下线）	String	ALB 实例的私网IP地址。	172.XX.XX.33
EniId（即将下线）	String	ALB 实例占用的网卡ID。	eni-2fe6rabqt8gxruv8u8c9f****
EipAddress（即将下线）	String	ALB 实例的公网IP地址。	10.XX.XX.27
BusinessStatus	String	ALB 实例是否被锁定。 Normal: 正常。 FinancialLocked: 被锁定。	FinancialLocked
LockReason	String	ALB 实例被锁定的原因。该参数只有实例处于 FinancialLocked 状态时有返回值。 Financial: 因欠费被锁定。 Security: 因安全被锁定。	Financial
OverdueTime	String	ALB 实例被冻结的时间。该参数只有实例处于 FinancialLocked 状态时有返回值。	2021-08-11T16:37:37Z
DeletedTime	String	ALB 实例的预期回收时间。该参数只有实例处于 FinancialLocked 状态时有返回值。	2021-08-11T16:37:37Z
LoadBalancerBillingType	Integer	ALB 实例的计费类型。1：LCU 性能容量单元。	1
DNSName	String	DNS域名。	alb-qwe1344.cn-beijing.volcalb.com
ZoneMappings	Array	ALB 实例在不同可用区下的配置信息。具体参见下表 ZoneMappings。	-
DeleteProtection	String	ALB 实例的删除保护功能为开启或关闭状态。 off：删除保护功能为关闭状态。 on：删除保护功能为开启状态。	off
ProjectName	String	实例所属项目名称。	default
Tags	Array	实例所属标签，具体参见下表 Tags。	-

说明

SubnetId、EipId、EniAddress、EniId、EipAddress 字段即将下线，请使用 ZoneMappings 字段接入服务，指定需要部署的可用区和子网信息。

ZoneMappings

参数	类型	参数说明	示例值
ZoneId	String	ALB 实例所处的可用区	cn-beijing-a
SubnetId	String	ALB 实例在该可用区的子网ID。	subnet-bp12mw1f8k3jgy****
LoadBalancerAddresses	Array	ALB 实例在该可用区的IP地址。具体参见下表 LoadBalancerAddresses 。	-

LoadBalancerAddresses

参数	类型	参数说明	示例值
EniAddress	String	ALB 实例在该可用区的私网IP地址。	172.XX.XX.33
EniId	String	ALB 实例在该可用区占用的网卡ID。	eni-2fe6rabqt8g****xruv8u8c9f
EipAddress	String	ALB 实例在该可用区的公网IP地址。	10.XX.XX.27
EipId	String	ALB 实例在该可用区的公网IP ID。	eip-2fe698wsnj****oxruvtryndp
Eip	Array	ALB 实例在该可用区的公网IP的信息。具体参见下表 Eip 。	-
EniIpv6Address	String	IPv4&IPv6 双栈类型的 ALB 实例，在该可用区的 IPv6 地址。	2408:4005:XX:XX:200
Ipv6EipId	String	IPv4&IPv6 双栈类型的 ALB 公网实例，在该可用区的 IPv6 公网带宽 ID。	eip-2fe698wsnj****oxruvtryndp
Ipv6Eip	Struct	IPv4&IPv6 双栈类型的 ALB 公网实例，在该可用区的 IPv6 公网带宽的信息。具体参见下表 Ipv6Eip 。	-

Eip

参数	类型	参数说明	示例值
ISP	String	ALB 实例上的公网IP线路类型，支持取值： BGP：BGP多线（默认值）。	BGP
EipBillingType	Integer	公网IP的计费方式。，支持取值： 2：按带宽上限计费（默认值）。 3：按实际流量计费。	2
Bandwidth	Integer	公网IP的带宽峰值，单位为Mbps。	10
EipAddress	String	负载均衡实例的公网IP地址。	10.XX.XX.27
SecurityProtectionTypes	Array	公网IP 的防护类型。具体取值如下： AntiDDoS_Enhanced：增强防护类型的公网IP，可加入到 DDoS 原生防护实例。空值：基础防护类型的公网IP。	-
EipType	String	ALB 实例上的公网IP类型，支持取值：空：弹性公网IP。 anycast：Anycast公网IP。	anycast
PopLocations	Array	ALB 作为Anycast公网IP的源站时，关联的接入点信息。仅绑定Anycast公网IP时有效。具体参见下表 PopLocation 。	-
AssociationMode	String	ALB 作为Anycast公网IP的源站类型，仅绑定Anycast公网IP时有效。支持取值： Default：默认模式。 Normal：普通模式。	Default

PopLocation

参数	类型	参数说明	示例值
PopId	String	Anycast公网IP的接入点ID。	cn-beijing-pop
PopName	String	Anycast公网IP的接入点名称。	北京-接入点

Ipv6Eip

参数	类型	参数说明	示例
ISP	String	公网ALB 实例的 IPv6 公网带宽的线路类型。支持选择如下： BGP：BGP多线（默认值）。	BGP
BillingType	Integer	公网ALB 实例的 IPv6 公网带宽的计费类型。取值如下： 2：按量计费-按带宽上限计费。 3：按量计费-按实际流量计费（默认值）。	2
Bandwidth	Integer	公网ALB 实例的IPv6公网带宽的带宽上限，单位为Mbps。	200

参数

类型

参数说明

示例

ISP

String

公网ALB 实例的 IPv6 公网带宽的线路类型。支持选择如下：

BGP：BGP多线（默认值）。

BGP

BillingType

Integer

公网ALB 实例的 IPv6 公网带宽的计费类型。取值如下：

2：按量计费-按带宽上限计费。
3：按量计费-按实际流量计费（默认值）。

Bandwidth

Integer

公网ALB 实例的IPv6公网带宽的带宽上限，单位为Mbps。

200

Tags

参数	类型	参数说明	示例
Key	String	用户标签的标签键。具体规则如下：长度限制为1～128个字符。大小写敏感。不能以volc:的任意大小写组合开头。不能以空格开头或结尾。允许包含各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。同一资源的标签键不允许重复。	key
Value	String	用户标签的标签键。同一资源的标签键不允许重复。具体规则如下：长度限制为1～128个字符。大小写敏感。不能以volc:的任意大小写组合开头。不能以空格开头或结尾。允许包含各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。同一资源的标签键不允许重复。	value

参数

类型

参数说明

示例

Key

String

用户标签的标签键。具体规则如下：

长度限制为1～128个字符。
大小写敏感。
不能以volc:的任意大小写组合开头。
不能以空格开头或结尾。
允许包含各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。
同一资源的标签键不允许重复。

key

Value

String

用户标签的标签键。同一资源的标签键不允许重复。具体规则如下：

长度限制为1～128个字符。
大小写敏感。
不能以volc:的任意大小写组合开头。
不能以空格开头或结尾。
允许包含各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。
同一资源的标签键不允许重复。

value

示例

请求示例

GET /?Action=DescribeLoadBalancers&Version=2020-04-01&LoadBalancerId=alb-3ciyamfv3tdds6****seik4kn&PageNumber=1&PageSize=20&VpcId=vpc-2fe624a31****5oxruuoxjjug HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: alb

响应示例

{
    "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
                            }
                        ]
                    }
                ]
            },
      }
}

错误码

如果响应正文包含 Error 字段，则表示 API 请求失败。此处仅展示当前 API 的错误码，更多错误码请参见公共错误码。

HTTP Code	错误码	错误信息	错误描述
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	InvalidEipAddress.Malformed	The specified EipAddress is malformed.	指定的 EipAddress 参数格式不合法。
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 重复。

API 说明

使用限制

快速调试

URI 参数

请求正文

响应正文

示例

请求示例

响应示例

错误码

应用型负载均衡

DescribeLoadBalancers

API 说明

使用限制

快速调试

URI 参数

请求正文

响应正文

示例

请求示例

响应示例

错误码