DescribeNetworkLoadBalancerAttributes--负载均衡-火山引擎

文档中心

导航

DescribeNetworkLoadBalancerAttributes

最近更新时间：2024.12.04 17:10:13首次发布时间：2024.12.04 17:10:13

调用 DescribeNetworkLoadBalancerAttributes 接口，查询网络型负载均衡实例的详细信息。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeNetworkLoadBalancerAttributes	要执行的操作，取值为DescribeNetworkLoadBalancerAttributes。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
LoadBalancerId	String	是	nlb-bp1b6c719dfa08ex****	NLB实例ID。您可以调用DescribeNetworkLoadBalancers接口获取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	测试实例	NLB实例的描述。
Ipv4NetworkType	String	intranet	NLB实例的IPv4网络类型。 internet：公网类型。 intranet：私网类型。
Ipv6NetworkType	String	intranet	NLB实例的IPv6网络类型。 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: 被锁定。
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	List of String	["sg-bpo05q8so05qmh1**", "sg-5eorfq84r05rfmhw**"]	NLB实例关联的非托管安全组ID。
ModificationProtectionStatus	String	ConsoleProtection	NLB实例是否开启控制台上修改保护。 NonProtection或空：关闭，允许通过控制台修改实例或删除实例。 ConsoleProtection：开启，禁止通过控制台修改实例或删除实例。
Tags	Array of Struct	--	NLB实例的标签信息。具体请参见下表“Tags”。
ZoneMappings	Array of struct	--	NLB实例的可用区信息。具体请参见下表“ZoneMappings”。

Tags

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

ZoneMappings

名称	类型	示例值	描述
ZoneId	String	cn-guangzhou-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	List of String	192.XX.XX.12	NLB实例的私网IPv4 LIP地址。
Ipv6LocalAddresses	List of String	2000:1000:2c7f:fe40:ca2f:dd0a:XX.XX	NLB实例的私网IPv6 LIP地址。

请求示例

GET /?Action=DescribeNetworkLoadBalancerAttributes&Version=2020-04-01&LoadBalancerId=nlb-bp1b6c719dfa08ex**** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-guangzhou
Service: clb

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202409291106382514606306AF947C****",
        "Action": "DescribeNetworkLoadBalancerAttributes",
        "Version": "2020-04-01",
        "Service": "clb",
        "Region": "cn-guangzhou"
    },    
    "Result": {
        "RequestId": "202409291106382514606306AF947C****",
        "CreateTime": "2024-09-25T07:43:33Z",
        "UpdateTime": "2024-09-28T22:17:17Z",
        "LoadBalancerId": "nlb-bp1b6c719dfa08ex****",
        "AccountId": "210005****",
        "ProjectName": "default",
        "LoadBalancerName": "hyh-双栈",
        "Status": "Active",
        "Description": "",
        "Ipv4NetworkType": "intranet",
        "Ipv6NetworkType": "intranet",
        "IpAddressVersion": "dualstack",
        "CrossZoneEnabled": true,
        "DNSName": "nlb-bp1b6c719dfa08ex****.cn-guangzhou.nlb.volces.com",
        "BillingType": 3,
        "BillingStatus": "Normal",
        "OverdueTime": "",
        "ReclaimedTime": "",
        "Ipv4BandwidthPackageId": "",
        "Ipv6BandwidthPackageId": "",
        "VpcId": "vpc-12agbbyq03ls017q7y2o5****",
        "ManagedSecurityGroupId": "sg-12azu6bde6ps017q7y2k0****",
        "SecurityGroupIds": [
            "sg-12agbc4n3frpc17q7y2ef****"
        ],
        "ModificationProtectionStatus": "NonProtection",
        "Tags": [],
        "ZoneMappings": [
            {
                "ZoneId": "cn-guangzhou-a",
                "SubnetId": "subnet-2ferq7fls8wzk59gp67db****",
                "EniId": "eni-im4a6v3w6hhc8gbssxqf****",
                "Ipv4Address": "192.XX.XX.2",
                "Ipv4EipAddress": "",
                "Ipv6Address": "2000:1000:XX:XX:37b5:d38d:ff1:ff1",
                "Ipv4EipId": "",
                "Ipv6EipId": "",
                "Ipv4HcStatus": "Healthy",
                "Ipv6HcStatus": "Healthy"
            },
            {
                "ZoneId": "cn-guangzhou-b",
                "SubnetId": "subnet-12avcu4ecyvwg17q7y2pr****",
                "EniId": "eni-2fe4wwrl491xc59gp68bo****",
                "Ipv4Address": "192.XX.XX.2",
                "Ipv4EipAddress": "",
                "Ipv6Address": "2000:1000:6e3f:XX:XX:8c39:ab71:8ef3",
                "Ipv4EipId": "",
                "Ipv6EipId": "",
                "Ipv4HcStatus": "Healthy",
                "Ipv6HcStatus": "Healthy"
            }
        ]
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。