调用GetLoadBalancerAttribute接口根据实例ID查询网络型负载均衡实例的详细配置。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 GetLoadBalancerAttribute

系统规定参数。取值：GetLoadBalancerAttribute。
LoadBalancerId String 是 nlb-83ckzc8d4xlp8o****

网络型负载均衡实例ID。
DryRun Boolean 否 false

是否只预检此次请求。取值：

  • true：发送检查请求，不会查询实例的配置信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。
  • false（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。
ClientToken String 否 123e4567-e89b-12d3-a456-426655440000

客户端Token，用于保证请求的幂等性。

从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

说明 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。
RegionId String 否 cn-hangzhou

网络型负载均衡实例所在的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

返回数据

名称 类型 示例值 描述
RequestId String CEF72CEB-54B6-4AE8-B225-F876FF7BA984

请求ID。
RegionId String cn-hangzhou

网络型负载实例所在的地域ID。
LoadBalancerId String nlb-83ckzc8d4xlp8o****

网络型负载均衡实例ID。
LoadBalancerName String NLB1

网络型负载均衡实例名称。

长度为2~128个英文或中文字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。
LoadBalancerType String network

负载均衡类型。仅取值：network，表示网络型负载均衡。
AddressType String Internet

网络型负载均衡的IPv4的网络地址类型。取值：

  • Internet：公网。负载均衡具有公网IP地址，DNS域名被解析到公网IP，因此可以在公网环境访问。
  • Intranet：私网。负载均衡只有私网IP地址，DNS域名被解析到私网IP，因此只能被负载均衡所在VPC的内网环境访问。
AddressIpVersion String ipv4

协议版本。取值：

  • ipv4：IPv4类型。
  • DualStack：双栈类型。
Ipv6AddressType String Internet

网络型负载均衡的IPv6地址类型。取值：

  • Internet：负载均衡具有公网IP地址，DNS域名被解析到公网IP，因此可以在公网环境访问。
  • Intranet：负载均衡只有私网IP地址，DNS域名被解析到私网IP，因此只能被负载均衡所在VPC的内网环境访问。
LoadBalancerStatus String Active

网络型负载均衡实例状态。取值：

  • Inactive：已停止，表示实例监听不会再转发流量。
  • Active：运行中。
  • Provisioning：创建中。
  • Configuring：变配中。
  • CreateFailed：创建失败，此时不会产生费用，实例只能被删除。
LoadBalancerBusinessStatus String Normal

网络型负载均衡的业务状态。取值：

  • Abnormal：异常状态。
  • Normal：正常状态。
OperationLocks Array of OperationLock

网络型负载均衡实例处于锁定状态列表。在LoadBalancerBussinessStatus为Abnormal（异常状态）时有效。
LockType String SecurityLocked

锁定的类型。取值 ：

  • SecurityLocked：安全锁定。
  • RelatedResourceLocked：关联锁定。
  • FinancialLocked：欠费锁定。
  • ResidualLocked：残留锁定。
LockReason String 业务异常。

锁定的原因。
VpcId String vpc-bp1b49rqrybk45nio****

网络型负载均衡实例的专有网络ID。
CreateTime String 2022-07-02T02:49:05Z

资源创建时间，使用格林威治时间，格式为yyyy-MM-ddTHH:mm:ssZ。
ResourceGroupId String rg-atstuj3rtop****

资源组ID。
DNSName String nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com

DNS域名。
ZoneMappings Array of ZoneMapping

可用区及交换机映射列表，至少需要添加2个可用区，最多支持添加10个可用区。
VSwitchId String vsw-bp1rmcrwg3erh1fh8****

可用区对应的交换机，每个可用区默认使用一台交换机和一个子网。
ZoneId String cn-hangzhou-a

可用区ID，您可以通过调用DescribeZones接口获取。
LoadBalancerAddresses Array of LoadBalancerAddress

网络型负载均衡实例地址信息。
EniId String eni-bp12f1xhs5yal61a****

ENI的ID。
PrivateIPv4Address String 192.168.3.32

网络型负载均衡实例私网IPv4地址。
AllocationId String eip-bp1aedxso6u80u0qf****

弹性公网IP实例ID。
PublicIPv4Address String 120.XX.XX.69

网络型负载均衡实例公网IPv4地址。
Ipv6Address String 2001:db8:1:1:1:1:1:1

网络型负载均衡实例IPv6地址。
BandwidthPackageId String cbwp-bp1vevu8h3ieh****

公网类型实例关联的共享带宽包ID。
SecurityGroupIds Array of String sg-bp10uag3q0jkxu72****

网络型负载均衡实例绑定的安全组ID。
CrossZoneEnabled Boolean true

网络型负载均衡实例是否开启跨可用区。取值：

  • true：开启。
  • false：关闭。
LoadBalancerBillingConfig Object

负载均衡实例计费配置。
PayType String PostPay

网络型负载均衡实例的计费类型。

仅取值PostPay：表示按量计费。
Cps Integer 100

网络型负载均衡实例每秒新建连接限速值。取值范围：0~1000000。

0表示不限速。
DeletionProtectionConfig Object

删除保护配置。
Enabled Boolean true

删除保护状态，取值：

  • true：开启状态。
  • false：关闭状态。
Reason String 实例运行中

更改删除保护状态的原因。长度为2~128个英文或中文字符，必须以大小字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。
EnabledTime String 2022-11-02T02:49:05Z

删除保护开启时间，使用格林威治时间，格式为yyyy-MM-ddTHH:mm:ssZ。
ModificationProtectionConfig Object

修改保护配置。
Status String ConsoleProtection

网络型负载均衡修改保护状态。取值：

  • NonProtection：不保护，表示不允许传入修改保护配置的Reason字段。如果配置了Reason，则清空其配置信息。
  • ConsoleProtection：控制台修改保护，此时允许传入修改保护配置的Reason字段。
说明 当取值为ConsoleProtection，即开启修改保护后，用户不能通过负载均衡控制台修改实例配置，但可以通过调用API修改实例配置。
Reason String 业务保障期

输入开启修改保护的原因。长度为2~128个英文或中文字符，必须以大小字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。

仅在修改保护配置的Status为ConsoleProtection有效且合法。
EnabledTime String 2022-12-02T02:49:05Z

修改保护时间，使用格林威治时间，格式为yyyy-MM-ddTHH:mm:ssZ。

示例

请求示例

http(s)://[Endpoint]/?Action=GetLoadBalancerAttribute
&LoadBalancerId=nlb-83ckzc8d4xlp8o****
&DryRun=false
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&RegionId=cn-hangzhou
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetLoadBalancerAttributeResponse>
    <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
    <RegionId>cn-hangzhou</RegionId>
    <LoadBalancerId>nlb-83ckzc8d4xlp8o****</LoadBalancerId>
    <LoadBalancerName>NLB1</LoadBalancerName>
    <LoadBalancerType>network</LoadBalancerType>
    <AddressType>Internet</AddressType>
    <AddressIpVersion>ipv4</AddressIpVersion>
    <Ipv6AddressType>Internet</Ipv6AddressType>
    <LoadBalancerStatus>Active</LoadBalancerStatus>
    <LoadBalancerBusinessStatus>Normal</LoadBalancerBusinessStatus>
    <OperationLocks>
        <LockType>SecurityLocked</LockType>
        <LockReason>业务异常。</LockReason>
    </OperationLocks>
    <VpcId>vpc-bp1b49rqrybk45nio****</VpcId>
    <CreateTime>2022-07-02T02:49:05Z</CreateTime>
    <ResourceGroupId>rg-atstuj3rtop****</ResourceGroupId>
    <DNSName>nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com</DNSName>
    <ZoneMappings>
        <VSwitchId>vsw-bp1rmcrwg3erh1fh8****</VSwitchId>
        <ZoneId>cn-hangzhou-a</ZoneId>
        <LoadBalancerAddresses>
            <EniId>eni-bp12f1xhs5yal61a****</EniId>
            <PrivateIPv4Address>192.168.3.32</PrivateIPv4Address>
            <AllocationId>eip-bp1aedxso6u80u0qf****</AllocationId>
            <PublicIPv4Address>120.XX.XX.69</PublicIPv4Address>
            <Ipv6Address>2001:db8:1:1:1:1:1:1</Ipv6Address>
        </LoadBalancerAddresses>
    </ZoneMappings>
    <BandwidthPackageId>cbwp-bp1vevu8h3ieh****</BandwidthPackageId>
    <SecurityGroupIds>sg-bp10uag3q0jkxu72****</SecurityGroupIds>
    <CrossZoneEnabled>true</CrossZoneEnabled>
    <LoadBalancerBillingConfig>
        <PayType>PostPay</PayType>
    </LoadBalancerBillingConfig>
    <Cps>100</Cps>
    <DeletionProtectionConfig>
        <Enabled>true</Enabled>
        <Reason>实例运行中</Reason>
        <EnabledTime>2022-11-02T02:49:05Z</EnabledTime>
    </DeletionProtectionConfig>
    <ModificationProtectionConfig>
        <Status>ConsoleProtection</Status>
        <Reason>业务保障期</Reason>
        <EnabledTime>2022-12-02T02:49:05Z</EnabledTime>
    </ModificationProtectionConfig>
</GetLoadBalancerAttributeResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "RegionId" : "cn-hangzhou",
  "LoadBalancerId" : "nlb-83ckzc8d4xlp8o****",
  "LoadBalancerName" : "NLB1",
  "LoadBalancerType" : "network",
  "AddressType" : "Internet",
  "AddressIpVersion" : "ipv4",
  "Ipv6AddressType" : "Internet",
  "LoadBalancerStatus" : "Active",
  "LoadBalancerBusinessStatus" : "Normal",
  "OperationLocks" : [ {
    "LockType" : "SecurityLocked",
    "LockReason" : "业务异常。"
  } ],
  "VpcId" : "vpc-bp1b49rqrybk45nio****",
  "CreateTime" : "2022-07-02T02:49:05Z",
  "ResourceGroupId" : "rg-atstuj3rtop****",
  "DNSName" : "nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com",
  "ZoneMappings" : [ {
    "VSwitchId" : "vsw-bp1rmcrwg3erh1fh8****",
    "ZoneId" : "cn-hangzhou-a",
    "LoadBalancerAddresses" : [ {
      "EniId" : "eni-bp12f1xhs5yal61a****",
      "PrivateIPv4Address" : "192.168.3.32",
      "AllocationId" : "eip-bp1aedxso6u80u0qf****",
      "PublicIPv4Address" : "120.XX.XX.69",
      "Ipv6Address" : "2001:db8:1:1:1:1:1:1"
    } ]
  } ],
  "BandwidthPackageId" : "cbwp-bp1vevu8h3ieh****",
  "SecurityGroupIds" : [ "sg-bp10uag3q0jkxu72****" ],
  "CrossZoneEnabled" : true,
  "LoadBalancerBillingConfig" : {
    "PayType" : "PostPay"
  },
  "Cps" : 100,
  "DeletionProtectionConfig" : {
    "Enabled" : true,
    "Reason" : "实例运行中",
    "EnabledTime" : "2022-11-02T02:49:05Z"
  },
  "ModificationProtectionConfig" : {
    "Status" : "ConsoleProtection",
    "Reason" : "业务保障期",
    "EnabledTime" : "2022-12-02T02:49:05Z"
  }
}

错误码

访问错误中心查看更多错误码。