负载均衡
负载均衡
网络型负载均衡NLB
请输入
- 文档首页
负载均衡API参考NLB实例DescribeNetworkLoadBalancerAttributes - 查看NLB实例的详情
复制全文
下载 pdfDescribeNetworkLoadBalancerAttributes - 查看NLB实例的详情
文档反馈
问问助手调用 DescribeNetworkLoadBalancerAttributes 接口，查看NLB实例的详细信息。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action String 必选 示例值：DescribeNetworkLoadBalancerAttributes
要执行的操作，取值为 DescribeNetworkLoadBalancerAttributes。
Version String 必选 示例值：2020-04-01
API版本信息，当前版本为 2020-04-01。
LoadBalancerId String 必选 示例值：nlb-bp1b6c719dfa08ex****
NLB实例ID。
返回参数
RequestId String 示例值：202409291106382514606306AF947C****
请求ID。
CreateTime String 示例值：2024-08-11T16:37:37Z
NLB实例的创建时间。
UpdateTime String 示例值：2024-08-11T16:37:37Z
NLB实例的最近操作时间。
LoadBalancerId String 示例值：nlb-bp1b6c719dfa08ex****
NLB实例ID。
AccountId String 示例值：210012****
NLB实例所属的账号ID。
ProjectName String 示例值：default
NLB实例所属项目的名称。
LoadBalancerName String 示例值：nlb-test1
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地址类型。
- ipv4：IPv4版本。
- dualstack：双栈，即同时支持IPv4版本和IPv6版本。
CrossZoneEnabled Boolean 示例值：true
NLB实例是否开启跨可用区转发。
DNSName String 示例值：nlb-bp1aevy8sofi8mh1****.cn-ningbo-sdv.volces.com
NLB实例的DNS地址。
BillingType Integer 示例值：3
NLB实例的计费类型。
- 3：按使用量计费
BillingStatus String 示例值：FinancialLocked
NLB实例的计费状态。
- Normal: 正常。
- FinancialLocked: 被锁定。
ExpectedOverdueTime String 示例值：2023-07-17T01:37:38Z
NLB实例欠费关停时间。
OverdueTime String 示例值：2023-07-17T01:37:38Z
NLB实例被锁定的时间。
参数BillingStatus为Normal时，本参数返回为空字符串。
ReclaimedTime String 示例值：2024-07-17T01:37:38Z
NLB实例的预期回收时间。
参数BillingStatus为Normal时，本参数返回为空字符串。
Ipv4BandwidthPackageId String 示例值：bwp-2zeo05qre24nhrqpy****
IPv4类型的共享带宽包ID。
说明
当实例未加入IPv4 共享带宽包时，该字段返回为空字符串。
Ipv6BandwidthPackageId String 示例值：bwp-b2weev3esweer8mt****
IPv6类型的共享带宽包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：开启，禁止通过控制台修改实例或删除实例。
AccessLog Object 示例值：--
NLB实例的访问日志信息。
AccessLogEnabled Boolean 示例值：true
是否开启访问日志。
- true：是
- flase：否
ProjectId String 示例值：fc6953c1-fe50-43aa-9d26-c1e0a207****
日志项目的ID。
TopicId String 示例值：74936ae4-bbd6-41de-a0d2-ed156203****
日志主题的ID。
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：异常。
Ipv4LocalAddresses String[] 示例值：192.XX.XX.12
NLB实例的私网IPv4 LIP地址。
Ipv6LocalAddresses String[] 示例值：2000:1000:2c7f:fe40:ca2f:dd0a:XX.XX
NLB实例的私网IPv6 LIP地址。
DNSAffinity Boolean 示例值：false
是否开启 DNS 可用区亲和性。
- true：私网客户端优先解析至同可用区（AZ）的 NLB 节点 IP，流量不跨 AZ；当同 AZ 节点故障时，自动返回所有非故障 AZ 的 IP。
- false：DNS 返回实例全部 AZ 的节点 IP，由客户端随机或轮询选择，可能产生跨 AZ 访问。
说明
仅私网解析，公网DNS不受影响。
请求示例
GET /?Action=DescribeNetworkLoadBalancerAttributes&Version=2020-04-01&LoadBalancerId=nlb-bp1b6c719dfa08ex**** HTTP/1.1
Host: clb.cn-beijing.volcengineapi.com
Date: 20260310T094038Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251121/cn-beijing/clb/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
返回示例
{
"ResponseMetadata": {
"RequestId": "20230604110420****100232280022D31",
"Action": "DescribeNetworkLoadBalancerAttributes",
"Version": "2020-04-01",
"Service": "clb",
"Region": "cn-beijing"
},
"Result": {
"AccessLog": {
"TopicId": "74936ae4-bbd6-41de-a0d2-ed156203****",
"ProjectId": "fc6953c1-fe50-43aa-9d26-c1e0a207****",
"AccessLogEnabled": true
},
"AccountId": "210012****",
"BillingStatus": "FinancialLocked",
"BillingType": 3,
"CreateTime": "2024-08-11T16:37:37Z",
"CrossZoneEnabled": true,
"DNSName": "nlb-bp1aevy8sofi8mh1****.cn-ningbo-sdv.volces.com",
"Description": "test",
"ExpectedOverdueTime": "2023-07-17T01:37:38Z",
"IpAddressVersion": "ipv4",
"Ipv4BandwidthPackageId": "bwp-2zeo05qre24nhrqpy****",
"Ipv4NetworkType": "intranet",
"Ipv6BandwidthPackageId": "bwp-b2weev3esweer8mt****",
"Ipv6NetworkType": "intranet",
"LoadBalancerId": "nlb-bp1b6c719dfa08ex****",
"LoadBalancerName": "nlb-test1",
"ManagedSecurityGroupId": "sg-bp1aevy8sofi8mh1****",
"ModificationProtectionStatus": "ConsoleProtection",
"OverdueTime": "2023-07-17T01:37:38Z",
"ProjectName": "default",
"ReclaimedTime": "2024-07-17T01:37:38Z",
"RequestId": "202409291106382514606306AF947C****",
"SecurityGroupIds": [
"sg-bpo05q8so05qmh1****",
"sg-5eorfq84r05rfmhw****"
],
"Status": "Active",
"Tags": [
{
"Key": "k1",
"Value": "v1"
}
],
"UpdateTime": "2024-08-11T16:37:37Z",
"VpcId": "vpc-bp1aevy8sofi8mh1****",
"ZoneMappings": [
{
"EniId": "eni-bp1aevy8sofi8mh1****",
"ZoneId": "cn-beijing-a",
"SubnetId": "subnet-5eorfq84r05rfmhw****",
"Ipv4EipId": "eip-2beasvyfs2fiwmws****",
"Ipv6EipId": "eip-2zaiwb7ujxscd****",
"Ipv4Address": "192.XX.XX.10",
"Ipv6Address": "2000:1000:2c7f:fe40:ca2f:dd0a:XX.XX",
"Ipv4HcStatus": "Healthy",
"Ipv6HcStatus": "Healthy",
"Ipv4EipAddress": "22.XX.XX.22",
"Ipv4LocalAddresses": [
""
],
"Ipv6LocalAddresses": [
""
]
}
]
}
}
错误码
最近更新时间：2026.09.18 11:20:51
这个页面对您有帮助吗？
有用
有用
无用
无用