全部产品
Search
文档中心

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

更新时间:Mar 01, 2024

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

调试

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

授权信息

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

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

请求参数

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

应用型负载均衡实例 ID。

alb-o9ulmq5hgn68jk****

返回参数

名称类型描述示例值
object

应用型负载均衡实例详细配置信息。

AccessLogConfigobject

访问日志配置。

LogProjectstring

日志项目。

sls-setter
LogStorestring

日志存储。

test
AddressAllocatedModestring

地址模式。取值 :

  • Fixed:固定 IP 模式,表示使用固定的 IP 地址。

  • Dynamic:动态 IP 模式,表示在每个可用区动态分配 IP 地址。

Dynamic
AddressTypestring

应用型负载均衡实例的网络地址类型。取值:

  • Internet:负载均衡具有公网 IP 地址,DNS 域名被解析到公网 IP,因此可以在公网环境访问。

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

Intranet
BandwidthPackageIdstring

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

cbwp-bp1vevu8h3ieh****
CreateTimestring

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

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

DNS 域名。

alb-95qnr2itwu9orb****.cn-hangzhou.alb.aliyuncs.com
DeletionProtectionConfigobject

删除保护配置。

Enabledboolean

删除保护状态,取值:

  • true:开启状态。

  • false:关闭状态。

true
EnabledTimestring

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

2022-08-02T02:49:05Z
LoadBalancerBillingConfigobject

应用型负载均衡实例计费配置。

PayTypestring

计费类型。

取值: PostPay 表示按量计费。

PostPay
LoadBalancerBussinessStatusstring

应用型负载均衡的业务状态。取值:

  • Abnormal:异常状态。

  • Normal:正常状态。

Normal
LoadBalancerEditionstring

应用型负载均衡的版本,不同版本有不同功能限制和计费策略。取值:

  • Basic:基础版。

  • Standard:标准版。

  • StandardWithWaf:WAF 增强版。

Standard
LoadBalancerIdstring

应用型负载均衡实例 ID。

alb-o9ulmq5hgn68jk****
LoadBalancerNamestring

实例名称。

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

alb1
LoadBalancerOperationLocksobject []

应用型负载均衡操作锁配置。

LockReasonstring

锁定的原因。在 LoadBalancerBussinessStatus异常时有效。

欠费
LockTypestring

锁定的类型。取值 :

  • SecurityLocked:安全锁定。

  • RelatedResourceLocked:关联锁定。

  • FinancialLocked:欠费锁定。

  • ResidualLocked:残留锁定。

FinancialLocked
LoadBalancerStatusstring

应用型负载均衡实例状态。取值:

  • Inactive: 已停止,表示实例监听不会再转发流量。

  • Active: 运行中。

  • Provisioning:创建中。

  • Configuring:变配中。

  • CreateFailed:创建失败,此时不会产生费用,实例只能被删除。

Active
ModificationProtectionConfigobject

修改保护配置。

Reasonstring

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

仅在 ModificationProtectionStatusConsoleProtection 有效且合法。

托管实例
Statusstring

应用型负载均衡修改保护状态。取值:

  • NonProtection:不保护,表示不允许传入 ModificationProtectionReason。如果配置了 ModificationProtectionReason,则清空其配置信息。

  • ConsoleProtection:控制台修改保护,此时允许传入 ModificationProtectionReason。

说明 当取值为 ConsoleProtection,即开启修改保护后,用户不能通过负载均衡控制台修改实例配置,但可以通过调用 API 修改实例配置。
ConsoleProtection
RegionIdstring

应用型负载均衡实例的地域 ID。

cn-hangzhou
RequestIdstring

请求 ID。

365F4154-92F6-4AE4-92F8-7FF34B540710
ResourceGroupIdstring

企业资源组 ID。

rg-atstuj3rtop****
Tagsobject []

标签。

Keystring

实例的标签键。

最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://https://

FinanceDept
Valuestring

实例的标签值。

最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://https://

FinanceJoshua
VpcIdstring

实例的专有网络 ID。

vpc-bp1b49rqrybk45nio****
ZoneMappingsobject []

可用区及交换机映射列表,至少指定两个可用区。

LoadBalancerAddressesobject []

实例地址。

Addressstring

标识 IPv4 类型的 IP 地址。

AddressIPVersionIPv4DualStack 均生效,公网或私网 IP 地址由 AddressType 决定。

192.168.10.1
Ipv6Addressstring

标识 IPv6 类型的 IP 地址。

仅在 AddressIPVersionDualStack 时有效,公网或私网 IP 地址由 Ipv6AddressType 决定。

2408:XXXX:39d:eb00::/56
IntranetAddressstring

IPv4 私网地址。

10.0.1.181
AllocationIdstring

弹性公网 IP 标识。

eip-uf6wm****1zj9
EipTypestring

公网 EIP 的类型。取值:

  • Common:弹性公网 IP,简称 EIP。
  • Anycast:任播弹性公网 IP,简称 Anycast EIP。
说明 ALB 支持绑定 Anycast EIP 的地域,请参见使用限制
Common
VSwitchIdstring

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

vsw-bp12mw1f8k3jgy****
ZoneIdstring

应用型负载均衡实例的可用区 ID。

您可以通过调用 DescribeZones 接口获取可用区 ID 对应的可用区的信息。

cn-hangzhou-a
AddressIpVersionstring

协议版本。取值:

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

应用型负载均衡 IPv6 的网络地址类型。取值:

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

示例

正常返回示例

JSON格式

{
  "AccessLogConfig": {
    "LogProject": "sls-setter",
    "LogStore": "test"
  },
  "AddressAllocatedMode": "Dynamic",
  "AddressType": "Intranet",
  "BandwidthPackageId": "cbwp-bp1vevu8h3ieh****",
  "CreateTime": "2022-07-02T02:49:05Z",
  "DNSName": "alb-95qnr2itwu9orb****.cn-hangzhou.alb.aliyuncs.com",
  "DeletionProtectionConfig": {
    "Enabled": true,
    "EnabledTime": "2022-08-02T02:49:05Z"
  },
  "LoadBalancerBillingConfig": {
    "PayType": "PostPay"
  },
  "LoadBalancerBussinessStatus": "Normal",
  "LoadBalancerEdition": "Standard",
  "LoadBalancerId": "alb-o9ulmq5hgn68jk****",
  "LoadBalancerName": "alb1",
  "LoadBalancerOperationLocks": [
    {
      "LockReason": "欠费",
      "LockType": "FinancialLocked"
    }
  ],
  "LoadBalancerStatus": "Active",
  "ModificationProtectionConfig": {
    "Reason": "托管实例",
    "Status": "ConsoleProtection"
  },
  "RegionId": "cn-hangzhou",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "ResourceGroupId": "rg-atstuj3rtop****",
  "Tags": [
    {
      "Key": "FinanceDept",
      "Value": "FinanceJoshua"
    }
  ],
  "VpcId": "vpc-bp1b49rqrybk45nio****",
  "ZoneMappings": [
    {
      "LoadBalancerAddresses": [
        {
          "Address": "192.168.10.1",
          "Ipv6Address": "2408:XXXX:39d:eb00::/56",
          "IntranetAddress": "10.0.1.181",
          "AllocationId": "eip-uf6wm****1zj9",
          "EipType": "Common"
        }
      ],
      "VSwitchId": "vsw-bp12mw1f8k3jgy****",
      "ZoneId": "cn-hangzhou-a"
    }
  ],
  "AddressIpVersion": "DualStack",
  "Ipv6AddressType": "Intranet"
}

错误码

HTTP status code错误码错误信息描述
400Forbidden.LoadBalancerAuthentication has failed for LoadBalancer.负载均衡操作鉴权失败
404ResourceNotFound.LoadBalancerThe specified resource %s is not found.资源%s不存在。

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

变更历史

变更时间变更内容概要操作
2024-01-17OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
    新增错误码:400
2023-11-03OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
出参OpenAPI 返回结构发生变更
2023-05-30OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
出参OpenAPI 返回结构发生变更
2023-05-29OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
出参OpenAPI 返回结构发生变更
2023-05-08OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
出参OpenAPI 返回结构发生变更
2023-04-11OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
出参OpenAPI 返回结构发生变更