ListLoadBalancers - 查询负载均衡

更新时间: 2023-11-07 11:48:33

查询指定地域的负载均衡,支持根据条件过滤。

调试

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

调试

授权信息

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

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

请求参数

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

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次API调用返回的NextToken值。
FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsinteger

分批次查询时每次显示的条目数。取值范围:1~100,默认值:20

20
ZoneIdstring

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

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

cn-hangzhou-a
LoadBalancerStatusstring

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

  • Inactive: 已停止,监听不再转发流量。

  • Active::运行中。

  • Provisioning:创建中。

  • Configuring:变配中。

  • CreateFailed:创建失败,此时不会产生费用,实例只能被删除。系统默认清理最近1天创建失败的实例。

Active
LoadBalancerBussinessStatusstring

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

  • Abnormal:异常。

  • Normal:正常。

Normal
LoadBalancerIdsarray

实例ID列表。最多支持20个应用型负载均衡实例ID。

string

实例的ID。最多支持20个实例ID。

alb-o9ulmq5hgn68jk****
LoadBalancerNamesarray

实例名称列表。最多支持10个实例名称。

string

实例名称。最多支持10个实例名称。

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

alb-instance-test
VpcIdsarray

应用型负载均衡实例所属的VPC ID。最多支持10个VPC ID。

string

应用型负载均衡实例所属的VPC ID。最多支持10个VPC ID。

vpc-bp1b49rqrybk45nio****
Tagobject []

实例标签。

Keystring

实例的标签键。最多支持输入20个标签键。一旦输入该值,则不允许为空字符串。

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

KeyTest
Valuestring

实例的标签值。最多支持输入20个标签值。一旦输入该值,可以为空字符串。

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

alueTest
AddressTypestring

实例地址类型。取值:

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

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

Intranet
PayTypestring

实例的计费类型。取值:

PostPay(默认值):表示按量计费。

PostPay
ResourceGroupIdstring

企业资源组ID。

rg-acfmxazb4ph****
AddressIpVersionstring

协议版本。取值:

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

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

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

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

Intranet
DNSNamestring

DNS域名。

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

返回参数

名称类型描述示例值
object

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

LoadBalancersobject []

应用型负载均衡实例列表。

AccessLogConfigobject

访问日志配置结构。

LogProjectstring

日志项目。

sls-setter
LogStorestring

日志存储。

test
AddressAllocatedModestring

地址模式。取值 :

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

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

Fixed
AddressTypestring

负载均衡的地址类型。取值:

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

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

Intranet
BandwidthPackageIdstring

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

cbwp-bp1vevu8h3ieh****
CreateTimestring

资源创建时间。

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

DNS域名。

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

删除保护配置。

Enabledboolean

删除保护状态,取值:

  • true:开启。

  • false:关闭。

true
EnabledTimestring

开启删除保护时间。

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

负载均衡实例计费配置。

PayTypestring

计费类型。取值:

PostPay:按量计费。

PostPay
LoadBalancerBussinessStatusstring

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

  • Abnormal:异常。

  • Normal:正常。

Normal
LoadBalancerEditionstring

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

  • Basic:基础版。

  • Standard:标准版。

  • StandardWithWaf:WAF增强版。

Standard
LoadBalancerIdstring

应用型负载均衡实例ID。

alb-o9ulmq5hgn68jk****
LoadBalancerNamestring

负载均衡实例名称。

alb-instance-test
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
ResourceGroupIdstring

企业资源组ID。

rg-atstuj3rtop****
Tagsobject []

标签列表。

Keystring

实例的标签键。

KeyTest
Valuestring

实例的标签值。

alueTest
VpcIdstring

应用型负载均衡实例的专有网络ID。

vpc-bp1b49rqrybk45nio****
AddressIpVersionstring

协议版本。取值:

  • IPv4:IPv4类型。

  • DualStack:双栈类型。

DualStack
Ipv6AddressTypestring

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

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

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

Intranet
MaxResultsinteger

分批次查询时每次显示的条目数。

20
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 如果NextToken为空表示没有下一次查询。
  • 如果NextToken有返回值,该取值表示下一次查询开始的令牌。
FFmyTO70tTpLG6I3FmYAXGKPd****
RequestIdstring

请求ID。

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

列表条目数。

100

示例

正常返回示例

JSON格式

{
  "LoadBalancers": [
    {
      "AccessLogConfig": {
        "LogProject": "sls-setter",
        "LogStore": "test"
      },
      "AddressAllocatedMode": "Fixed",
      "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": "alb-instance-test",
      "LoadBalancerOperationLocks": [
        {
          "LockReason": "欠费",
          "LockType": "FinancialLocked"
        }
      ],
      "LoadBalancerStatus": "Active",
      "ModificationProtectionConfig": {
        "Reason": "托管实例",
        "Status": "ConsoleProtection"
      },
      "ResourceGroupId": "rg-atstuj3rtop****",
      "Tags": [
        {
          "Key": "KeyTest",
          "Value": "alueTest"
        }
      ],
      "VpcId": "vpc-bp1b49rqrybk45nio****",
      "AddressIpVersion": "DualStack",
      "Ipv6AddressType": "Intranet"
    }
  ],
  "MaxResults": 20,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "TotalCount": 100
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-11-06OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:DNSName
2023-11-06OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:AddressIpVersion
    新增入参:Ipv6AddressType
阿里云首页 负载均衡 相关技术圈