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

调试

API Explorer

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

去调试

请求参数

下表中非必选参数均未传入时，返回当前账号下所有NLB实例。

Action String 必选示例值：DescribeNetworkLoadBalancers

要执行的操作，取值为 DescribeNetworkLoadBalancers。

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

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

MaxResults Integer 可选示例值：10

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

NextToken String 可选示例值：caeba0bbb2be03f84eb48b699f0a****

分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的NextToken参数值。

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

NLB实例的 ID。

N：表示NLB实例的序号，取值范围为1 ～ 20。

多个NLB实例ID间使用&分隔。

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

NLB实例所属VPC的ID。

LoadBalancerName String 可选示例值：nlb-test

NLB实例的名称。

Status String 可选示例值：Active

NLB实例的状态。取值如下：

Inactive：已停止。

Active：运行中。

Creating：创建中。

Provisioning：创建中。仅调用API创建NLB实例时存在该状态。

Configuring：配置中。

Deleting：删除中。

CreateFailed：创建失败。

IpAddressVersion String 可选示例值：ipv4

IP协议版本。取值如下：

ipv4：IPv4版本。

dualstack：双栈，即同时支持IPv4版本和IPv6版本。

ZoneId String 可选示例值：cn-beijing-a

可用区 ID。

您可以调用 DescribeNLBZones 接口，查看当前地域的可用区ID。

ProjectName String 可选示例值：default

NLB实例所属项目的名称。

说明

该参数不传入或传入为空时，表示查询所有项目的NLB实例。

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

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

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

多个标签键之间使用&分隔。

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

标签的标签值。

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

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

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

说明

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

该参数传入空值时，表示查询指定标签键下标签值为空的资源。

返回参数

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

请求ID。

NextToken String 示例值：caeba0bbb2be03f84eb48b699f0a****

本次调用返回的查询凭证值，返回为空表示没有下一页。

LoadBalancers Object[] 示例值：--

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

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

NLB实例的创建时间。

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

NLB实例的最近操作时间。

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

NLB实例ID。

AccountId String 示例值：210012****

NLB实例所属的账号ID。

ProjectName String 示例值：default

NLB实例所属项目的名称。

LoadBalancerName String 示例值：nlb-test

NLB实例的名称。

Status String 示例值：Active

NLB实例状态。

Inactive：已停止。

Active：运行中。

Creating：创建中。

Provisioning：创建中。仅调用API创建NLB实例时存在该状态。

Configuring：配置中。

Deleting：删除中。

CreateFailed：创建失败。

Description String 示例值：test

NLB实例的描述。

Ipv4NetworkType String 示例值：intranet

NLB实例的IPv4网络类型。

internet：公网类型。

intranet：私网类型。

Ipv6NetworkType String 示例值：intranet

NLB实例的IPv6网络类型。

internet：公网类型。

intranet：私网类型。

IpAddressVersion String 示例值：ipv4

NLB实例的IP地址类型。

CrossZoneEnabled Boolean 示例值：true

NLB实例是否开启跨可用区转发。

DNSName String 示例值：nlb-b2ea3vwwssefdmer****.cn-beijing.volces.com

NLB实例的DNS地址。

BillingType Integer 示例值：3

NLB实例的计费方式。

3：按使用量计费

BillingStatus String 示例值：FinancialLocked

NLB实例是否被锁定。

Normal：正常。

FinancialLocked：被锁定。

OverdueTime String 示例值：2023-07-17T01:37:38Z

NLB实例被锁定的时间。

参数BillingStatus为Normal时，该参数返回为空字符串。

ReclaimedTime String 示例值：2023-08-17T01:37:38Z

NLB实例的预期回收时间。

ExpectedOverdueTime String 示例值：2023-07-17T01:37:38Z

NLB实例欠费关停时间。

Ipv4BandwidthPackageId String 示例值：bwp-2zeo05qre24nhrqpy****

IPv4类型的共享带宽包ID。

说明

当实例未加入IPv4 共享带宽包时，该字段返回为空字符串。

Ipv6BandwidthPackageId String 示例值：bwp-b2weev3esweer8mt****

双栈类型的共享带宽包ID。

说明

实例为IPv4类型或实例未加入IPv6 共享带宽包时，该字段返回为空字符串。

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

NLB实例所属的VPC ID。

ManagedSecurityGroupId String 示例值：sg-bp1aevy8sofi8mh1****

系统为NLB实例自动关联的托管安全组ID。

SecurityGroupIds String[] 示例值：["sg-bpo05q8so05qmh1****", "sg-5eorfq84r05rfmhw****"]

NLB实例关联的非托管安全组ID。

ModificationProtectionStatus String 示例值：ConsoleProtection

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

NonProtection或空：关闭，允许通过控制台修改或删除实例。

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

Tags Object[] 示例值：--

NLB实例的标签信息。

Key String 示例值：k1

标签的标签键。

Value String 示例值：v1

标签的标签值。

ZoneMappings Object[] 示例值：--

NLB实例的可用区信息。

ZoneId String 示例值：cn-beijing-a

可用区 ID。

SubnetId String 示例值：subnet-5eorfq84r05rfmhw****

子网 ID。

EniId String 示例值：eni-bp1aevy8sofi8mh1****

网卡ID。

Ipv4Address String 示例值：192.XX.XX.10

NLB实例的私网IPv4 VIP地址。

Ipv4EipAddress String 示例值：22.XX.XX.22

公网IP地址。

Ipv6Address String 示例值：2000:1000:2c7f:fe40:ca2f:dd0a:XX.XX

NLB实例的私网IPv6 VIP地址。

Ipv4EipId String 示例值：eip-2beasvyfs2fiwmws****

NLB实例关联的公网IP的ID。

说明

NLB实例的IPv4 网络类型为“Intranet” 时，该参数返回为空字符串。

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

NLB实例关联的IPv6公网带宽的ID。

说明

NLB实例的IPv6 网络类型为“Intranet” 或NLB实例IP版本为“ipv4”时，该参数返回为空字符串。

Ipv4HcStatus String 示例值：Healthy

NLB实例私网IPv4地址的健康状态。

Healthy：健康。

Unhealthy：异常。

Ipv6HcStatus String 示例值：Healthy

NLB实例私网IPv6地址的健康状态。

Healthy：健康。

Unhealthy：异常。

DNSAffinity Boolean 示例值：false

是否开启 DNS 可用区亲和性。

true：私网客户端优先解析至同可用区（AZ）的 NLB 节点 IP，流量不跨 AZ；当同 AZ 节点故障时，自动返回所有非故障 AZ 的 IP。

false：DNS 返回实例全部 AZ 的节点 IP，由客户端随机或轮询选择，可能产生跨 AZ 访问。

说明

仅私网解析，公网DNS不受影响。

NetworkServiceInterfaceStatus String

请求示例

返回示例

错误码

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

状态码	错误码	错误信息	说明
400	DryRunOperation	Exception raised to indicate a successfully authorized action when the DryRun flag is set to true.	该请求设置为DryRun操作，操作授权已获得许可，但未被实际执行。
400	IdempotentParameterMismatch	Arguments on this idempotent request are inconsistent with arguments used in previous request(s).	此幂等请求的参数与前一个请求中使用的参数不一致。
400	InvalidClientToken.Malformed	The specified ClientToken is malformed.	指定的 ClientToken 参数格式不合法。
400	InvalidIncorrectOrder.Malformed	The specified index order is malformed.	指定的索引顺序参数格式不合法。
400	InvalidLoadBalancerName.Malformed	The specified LoadBalancerName is malformed.	指定的 LoadBalancerName 参数格式不合法。
400	InvalidMaxResult.Malformed	The specified MaxResult is malformed.	指定的 MaxResult 参数格式不合法。
400	InvalidMaxResults.Malformed	The specified MaxResults is malformed.	指定的 MaxResults 参数格式不合法。
400	InvalidNextToken.Malformed	The specified NextToken is malformed.	指定的 NextToken 参数格式不合法。
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.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.	已达到单次可指定过滤标签键值数量的上限。
409	InvalidOperation.Conflict	The specified resource operation conflicts.	指定的资源操作冲突。
412	IdempotentProcessing	The request uses the same client token as a previous one that is still in process.	幂等请求处理中。

负载均衡