文档

GetLoadBalancerAttribute - 查询负载均衡实例的详细信息

更新时间:

查询指定网络型负载均衡实例的详细信息。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
nlb:GetLoadBalancerAttributeRead
  • LoadBalancer
    acs:nlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

请求参数

名称类型必填描述示例值
LoadBalancerIdstring

网络型负载均衡实例 ID。

nlb-83ckzc8d4xlp8o****
DryRunboolean

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

  • true:发送检查请求,不会查询实例的配置信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后返回 HTTP 2xx 状态码并直接进行操作。
false
ClientTokenstring

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

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

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
123e4567-e89b-12d3-a456-426655440000
RegionIdstring

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

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

cn-hangzhou

返回参数

名称类型描述示例值
object

response

RequestIdstring

请求 ID。

CEF72CEB-54B6-4AE8-B225-F876FF7BA984
RegionIdstring

NLB 实例所在的地域 ID。

cn-hangzhou
LoadBalancerIdstring

NLB 实例 ID。

nlb-83ckzc8d4xlp8o****
LoadBalancerNamestring

NLB 实例名称。

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

NLB1
LoadBalancerTypestring

负载均衡类型。仅取值:network,表示网络型负载均衡。

network
AddressTypestring

NLB 实例的 IPv4 网络地址类型。取值:

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

协议版本。取值:

  • ipv4:IPv4 类型。
  • DualStack:双栈类型。
ipv4
Ipv6AddressTypestring

NLB 实例的 IPv6 地址类型。取值:

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

NLB 实例状态。取值:

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

NLB 的业务状态。取值:

  • Abnormal:异常状态。
  • Normal:正常状态。
Normal
OperationLocksobject []

NLB 实例处于锁定状态列表。在LoadBalancerBussinessStatusAbnormal(异常状态)时才返回当前参数。

LockTypestring

锁定的类型。取值 :

  • SecurityLocked:安全锁定。
  • RelatedResourceLocked:关联锁定。
  • FinancialLocked:欠费锁定。
  • ResidualLocked:残留锁定。
SecurityLocked
LockReasonstring

锁定的原因。

业务异常。
VpcIdstring

NLB 实例的专有网络 ID。

vpc-bp1b49rqrybk45nio****
CreateTimestring

资源创建时间,使用格林威治时间,格式为yyyy-MM-ddTHH:mm:ssZ

2022-07-02T02:49:05Z
ResourceGroupIdstring

资源组 ID。

rg-atstuj3rtop****
DNSNamestring

DNS 域名。

nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com
ZoneMappingsobject []

可用区及交换机映射列表,至少需要添加 2 个可用区,最多支持添加 10 个可用区。

VSwitchIdstring

可用区对应的交换机,每个可用区默认使用一台交换机和一个子网。

vsw-bp1rmcrwg3erh1fh8****
ZoneIdstring

可用区 ID,您可以通过调用 DescribeZones 接口获取。

cn-hangzhou-a
LoadBalancerAddressesobject []

网络型负载均衡实例地址信息。

EniIdstring

ENI 的 ID。

eni-bp12f1xhs5yal61a****
PrivateIPv4Addressstring

IPv4 私网 VIP 地址。NLB 对外提供服务的私网 IPv4 地址。

192.168.3.32
AllocationIdstring

弹性公网 IP 实例 ID。

eip-bp1aedxso6u80u0qf****
PublicIPv4Addressstring

NLB 实例公网 IPv4 地址。

120.XX.XX.69
Ipv6Addressstring

IPv6 VIP 地址。NLB 对外提供服务的 IPv6 地址。

2001:db8:1:1:1:1:1:1
PrivateIPv4HcStatusstring

NLB 实例私网 IPv4 地址的探测状态。取值:

  • Healthy:健康。
  • Unhealthy:异常。
说明 只有可用区状态(Status)为运行中(Active)时才返回该参数。
Healthy
PrivateIPv6HcStatusstring

NLB 实例 IPv6 地址的探测状态。取值:

  • Healthy:健康。
  • Unhealthy:异常。
说明 只有可用区状态(Status)为运行中(Active)时才返回该参数。
Healthy
Ipv4LocalAddressesarray

IPv4 Local 地址列表。NLB 与后端服务交互的地址列表。

string

IPv4 Local 地址。

192.168.36.16
Ipv6LocalAddressesarray

IPv6 Local 地址列表。NLB 与后端服务交互的地址列表。

string

IPv6 Local 地址。

2408:4005:357:ba00:64a2:221f:5685:8854
Statusstring

可用区状态。取值:

  • Active:启动。
  • Stopped:停止。该状态仅支持通过 CADT 容灾管理服务调用实现。
  • Shifted:DNS 摘除。
  • Starting:启动中。该状态仅支持通过 CADT 容灾管理服务调用实现。
  • Stopping:停止中。该状态仅支持通过 CADT 容灾管理服务调用实现。
Active
BandwidthPackageIdstring

公网类型实例关联的共享带宽包 ID。

cbwp-bp1vevu8h3ieh****
SecurityGroupIdsarray

NLB 实例绑定的安全组 ID。

string

NLB 实例绑定的安全组 ID。

sg-bp10uag3q0jkxu72****
CrossZoneEnabledboolean

NLB 实例是否开启跨可用区。取值:

  • true:开启。
  • false:关闭。
true
LoadBalancerBillingConfigobject

负载均衡实例计费配置。

PayTypestring

NLB 实例的计费类型。 仅取值 PostPay:表示按量计费。

PostPay
Cpsinteger

NLB 实例每秒新建连接限速值。取值范围:0~1000000

0 表示不限速。

100
DeletionProtectionConfigobject

删除保护配置。

Enabledboolean

删除保护状态,取值:

  • true:开启状态。
  • false:关闭状态。
true
Reasonstring

更改删除保护状态的原因。长度为 2~128 个英文或中文字符,必须以大小字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。

实例运行中
EnabledTimestring

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

2022-11-02T02:49:05Z
ModificationProtectionConfigobject

修改保护配置。

Statusstring

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

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

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

仅在修改保护配置的 StatusConsoleProtection 有效且合法。

业务保障期
EnabledTimestring

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

2022-12-02T02:49:05Z
Tagsobject []

标签列表。

TagKeystring

实例的标签键。

KeyTest
TagValuestring

实例的标签值。

ValueTest

示例

正常返回示例

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",
          "PrivateIPv4HcStatus": "Healthy",
          "PrivateIPv6HcStatus": "Healthy",
          "Ipv4LocalAddresses": [
            "192.168.36.16"
          ],
          "Ipv6LocalAddresses": [
            "2408:4005:357:ba00:64a2:221f:5685:8854"
          ]
        }
      ],
      "Status": "Active"
    }
  ],
  "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"
  },
  "Tags": [
    {
      "TagKey": "KeyTest",
      "TagValue": "ValueTest"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400DuplicatedParam.%sThe param of %s is duplicated.参数%s重复了
400OperationFailed.GetXipFailedOperation failed because GetXipFailed.操作失败,因为实例还在创建中。
403Forbidden.NoPermissionAuthentication is failed for NoPermission.因为账号没有权限,所以鉴权失败。
404ResourceNotFound.loadBalancerThe specified resource of loadbalancer is not found.找不到指定的负载均衡器资源,请检查输入参数。

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

变更历史

变更时间变更内容概要操作
2024-02-22OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
2024-02-04OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
出参OpenAPI 返回结构发生变更
2024-02-04OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
2023-12-18OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
2023-09-05OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 403 变更
    错误码 404 变更
    删除错误码:400
2023-08-22OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    新增错误码:400
    新增错误码:403
    新增错误码:404
2023-06-07OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-04-04OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更