AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 负载均衡 应用型负载均衡ALB 开发参考 API参考 API目录 实例 ListLoadBalancers - 查询负载均衡

ListLoadBalancers - 查询负载均衡

更新时间：
产品详情
我的收藏

查询实例配置。

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

alb:ListLoadBalancers

get

LoadBalancer

acs:alb:{#regionId}:{#accountId}:loadbalancer/*

LoadBalancer

acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

 无 无

请求参数

名称

类型

必填

描述

示例值
NextToken

string

否

是否拥有下一次查询的令牌（Token）。取值：

  • 第一次查询和没有下一次查询时，均无需填写。

  • 如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。

FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults

integer

否

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

20
ZoneId

string

否

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

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

cn-hangzhou-a
LoadBalancerStatus

string

否

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

  • Inactive： 已停止，监听不再转发流量。

  • Active:：运行中。

  • Provisioning：创建中。

  • Configuring：变配中。

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

Active
LoadBalancerBussinessStatus

string

否

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

  • Abnormal：异常。

  • Normal：正常。

Normal
LoadBalancerIds

array

否

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

string

否

实例的 ID。

alb-o9ulmq5hgn68jk****
LoadBalancerNames

array

否

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

string

否

实例名称。

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

alb-instance-test
VpcIds

array

否

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

string

否

应用型负载均衡实例所属的 VPC ID。

vpc-bp1b49rqrybk45nio****
Tag

array<object>

否

实例标签。

object

否

实例标签结构。

Key

string

否

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

最多支持 64 个字符，不能以aliyun和acs:开头，不能包含http://或者https://。

KeyTest
Value

string

否

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

最多支持 128 个字符，不能以aliyun和acs:开头，不能包含http://或者https://。

alueTest
AddressType

string

否

实例地址类型。取值：

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

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

Intranet
PayType

string

否

实例的计费类型。取值：

PostPay（默认值）：表示按量计费。

PostPay
ResourceGroupId

string

否

企业资源组 ID。

rg-acfmxazb4ph****
AddressIpVersion

string

否

协议版本。取值：

  • IPv4：IPv4 类型。

  • DualStack：双栈类型。

IPv4
Ipv6AddressType

string

否

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

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

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

Intranet
DNSName

string

否

DNS 域名。

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

返回参数

名称

类型

描述

示例值

object

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

LoadBalancers

array<object>

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

object

应用型负载均衡实例结构。

AccessLogConfig

object

访问日志配置结构。

LogProject

string

日志项目。

sls-setter
LogStore

string

日志存储。

test
AddressAllocatedMode

string

地址模式。取值 ：

  • Fixed：固定 IP 模式，表示使用固定 IP 地址。

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

Fixed
AddressType

string

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

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

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

Intranet
BandwidthPackageId

string

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

cbwp-bp1vevu8h3ieh****
CreateTime

string

资源创建时间。

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

string

DNS 域名。

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

object

删除保护配置。

Enabled

boolean

删除保护状态，取值：

  • true：开启。

  • false：关闭。

true
EnabledTime

string

开启删除保护时间。

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

object

负载均衡实例计费配置。

PayType

string

计费类型。取值：

PostPay：按量计费。

PostPay
LoadBalancerBussinessStatus

string

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

  • Abnormal：异常。

  • Normal：正常。

Normal
LoadBalancerEdition

string

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

  • Basic：基础版。

  • Standard：标准版。

  • StandardWithWaf：WAF 增强版。

Standard
LoadBalancerId

string

应用型负载均衡实例 ID。

alb-o9ulmq5hgn68jk****
LoadBalancerName

string

负载均衡实例名称。

alb-instance-test
LoadBalancerOperationLocks

array<object>

负载均衡操作锁配置。

object

负载均衡操作锁结构。

LockReason

string

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

欠费
LockType

string

锁定的类型。取值 ：

  • SecurityLocked：安全锁定。

  • RelatedResourceLocked：关联锁定。

  • FinancialLocked：欠费锁定。

  • ResidualLocked：残留锁定。

FinancialLocked
LoadBalancerStatus

string

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

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

  • Active: 运行中。

  • Provisioning：创建中。

  • Configuring：变配中。

  • CreateFailed：创建失败。

Active
ModificationProtectionConfig

object

修改保护配置。

Reason

string

开启修改保护的原因。

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

仅在 Status 为 ConsoleProtection 时返回。

托管实例
Status

string

应用型负载均衡实例的修改保护状态。取值：

  • NonProtection：未开启修改保护。如有配置 Reason，Reason 会被强制置空。

  • ConsoleProtection：已开启控制台修改保护。如有配置 Reason，Reason 可生效。

说明

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

ConsoleProtection
ResourceGroupId

string

企业资源组 ID。

rg-atstuj3rtop****
Tags

array<object>

标签列表。

object

标签结构。

Key

string

实例的标签键。

KeyTest
Value

string

实例的标签值。

alueTest
VpcId

string

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

vpc-bp1b49rqryhk45nio****
AddressIpVersion

string

协议版本。取值：

  • IPv4：IPv4 类型。

  • DualStack：双栈类型。

DualStack
Ipv6AddressType

string

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

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

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

Intranet
SecurityGroupIds

array

应用型负载均衡实例加入的安全组。

string

应用型负载均衡实例加入的安全组。

sg-2zejdtxxpu8c9tny****
MaxResults

integer

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

20
NextToken

string

是否拥有下一次查询的令牌（Token）。取值：

  • 如果 NextToken 为空表示没有下一次查询。

  • 如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。

FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId

string

请求 ID。

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

integer

列表条目数。

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-bp1b49rqryhk45nio****",
      "AddressIpVersion": "DualStack",
      "Ipv6AddressType": "Intranet",
      "SecurityGroupIds": [
        "sg-2zejdtxxpu8c9tny****"
      ]
    }
  ],
  "MaxResults": 20,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "TotalCount": 100
}

错误码

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

变更历史

更多信息，参考变更详情。

上一篇：UpdateLoadBalancerAddressTypeConfig - 变更负载均衡实例的网络类型配置下一篇：DisableDeletionProtection - 关闭删除保护