调用ListLoadBalancers来基于地域查询实例,支持基于实例ID、名称、状态、资源组ID和VPC ID对实例进行过滤。

调试

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

请求参数

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

系统规定的参数。

取值:ListLoadBalancers

NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

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

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

本次读取的最大数据记录数量,此参数为可选参数。取值范围:1~100。入参为空时,默认值为20

ZoneId String cn-hangzhou-a

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

LoadBalancerStatus String Active

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

  • Inactive: 已停止,监听不再转发流量。
  • Active::运行中。
  • Provisioning:创建中。
  • Configuring:变配中。
  • CreateFailed:创建失败,此时不会产生费用,实例只能被删除。系统默认清理最近1天创建失败的实例。
LoadBalancerBussinessStatus String Normal

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

  • Abnormal:异常。
  • Normal:正常。
LoadBalancerIds Array of String lb-bp1b6c719dfa08ex****

负载均衡实例的ID。最多支持20个实例ID。

LoadBalancerNames Array of String lb-instance-test

负载均衡实例名称。最多支持10个实例名称。

VpcIds Array of String vpc-bp1aevy8sofi8mh1q****

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

Tag Array

实例标签。

Key String KeyTest

实例的标签键值。取值范围:1~20

Value String alueTest

实例的标签值。取值范围:1~20

AddressType String Internet

地址类型。取值:

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

实例的计费类型。取值:

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

ResourceGroupId String rg-acfmxazb4ph****

企业资源组ID。

返回数据

名称 类型 示例值 描述
LoadBalancers Array of loadBalancer

负载均衡实例列表。

AccessLogConfig Object

访问日志配置结构。

LogProject String sls-setter

日志项目。

LogStore String test

日志存储。

AddressAllocatedMode String Fixed

地址模式。取值 :

  • Fixed:固定IP模式,表示使用固定IP地址。
  • Dynamic:动态IP模式,表示每个可用区动态分配IP地址。
AddressType String Internet

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

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

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

CreateTime String 2019-06-03T17:22Z

资源创建时间。

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

DNS域名。

DeletionProtectionConfig Object

删除保护配置。

Enabled Boolean true

删除保护状态,取值:

  • true:开启。
  • false:关闭。
EnabledTime String 2019-06-03T17:22Z

开启删除保护时间。

LoadBalancerBillingConfig Object

负载均衡实例计费配置。

PayType String PostPay

计费类型。取值:

PostPay:按量计费。

LoadBalancerBussinessStatus String Normal

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

  • Abnormal:异常。
  • Normal:正常。
LoadBalancerEdition String Standard

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

  • Basic:基础版
  • Standard:标准版
LoadBalancerId String lb-bp1b6c719dfa08ex****

负载均衡实例ID。

LoadBalancerName String lb-instance-test

负载均衡实例名称。

LoadBalancerOperationLocks Array of LoadBalancerOperationLock

负载均衡操作锁配置。

LockReason String 欠费

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

LockType String FinancialLocked

锁定的类型。取值 :

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

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

  • Inactive: 已停止,表示实例监听不会再转发流量。
  • Active: 运行中。
  • Provisioning:创建中。
  • Configuring:变配中。
  • CreateFailed:创建失败。
ModificationProtectionConfig Object

修改保护配置。

Reason String 托管实例

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

仅在ModificationProtectionStatusConsoleProtection有效且合法。

Status String ConsoleProtection

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

  • NonProtection:不保护,表示不允许传入ModificationProtectionReason。如果配置了ModificationProtectionReason,则清空其配置信息。
  • ConsoleProtection:控制台修改保护,此时允许传入ModificationProtectionReason。
ResourceGroupId String rg-atstuj3rtop****

企业资源组ID。

Tags Array of Tag

标签列表。

Key String FinanceDept

实例的标签键。

Value String FinanceJoshua

实例的标签值。

VpcId String vpc-25dvz****

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

MaxResults Integer 50

本次请求所返回的最大记录条数。

NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

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

  • 如果NextToken为空表示没有下一次查询。
  • 如果NextToken有返回值,该取值表示下一次查询开始的令牌。
RequestId String 365F4154-92F6-4AE4-92F8-7FF34B540710

请求ID。

TotalCount Integer 1000

本次请求条件下的数据总量。

示例

请求示例

http(s)://[Endpoint]/?Action=ListLoadBalancers
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&ZoneId=cn-hangzhou-a
&LoadBalancerStatus=Active
&LoadBalancerBussinessStatus=Normal
&LoadBalancerIds=["lb-bp1b6c719dfa08ex****"]
&LoadBalancerNames=["lb-instance-test"]
&VpcIds=["vpc-bp1aevy8sofi8mh1q****"]
&Tag=[{"Key":"KeyTest","Value":"alueTest"}]
&AddressType=Internet
&PayType=PrePay
&ResourceGroupId=rg-acfmxazb4ph****
&公共请求参数

正常返回示例

XML格式

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

<ListLoadBalancersResponse>
    <LoadBalancers>
        <AccessLogConfig>
            <LogProject>sls-setter</LogProject>
            <LogStore>test</LogStore>
        </AccessLogConfig>
        <AddressAllocatedMode>Fixed</AddressAllocatedMode>
        <AddressType>Internet</AddressType>
        <BandwidthPackageId>cbwp-bp1vevu8h3ieh****</BandwidthPackageId>
        <CreateTime>2019-06-03T17:22Z</CreateTime>
        <DNSName>alb-95qnr2itwu9orb****.cn-hangzhou.alb.aliyuncs.com</DNSName>
        <DeletionProtectionConfig>
            <Enabled>true</Enabled>
            <EnabledTime>2019-06-03T17:22Z</EnabledTime>
        </DeletionProtectionConfig>
        <LoadBalancerBillingConfig>
            <PayType>PostPay</PayType>
        </LoadBalancerBillingConfig>
        <LoadBalancerBussinessStatus>Normal</LoadBalancerBussinessStatus>
        <LoadBalancerEdition>Standard</LoadBalancerEdition>
        <LoadBalancerId>lb-bp1b6c719dfa08ex****</LoadBalancerId>
        <LoadBalancerName>lb-instance-test</LoadBalancerName>
        <LoadBalancerOperationLocks>
            <LockReason>欠费</LockReason>
            <LockType>FinancialLocked</LockType>
        </LoadBalancerOperationLocks>
        <LoadBalancerStatus>Active</LoadBalancerStatus>
        <ModificationProtectionConfig>
            <Reason>托管实例</Reason>
            <Status>ConsoleProtection</Status>
        </ModificationProtectionConfig>
        <ResourceGroupId>rg-atstuj3rtop****</ResourceGroupId>
        <Tags>
            <Key>FinanceDept</Key>
            <Value>FinanceJoshua</Value>
        </Tags>
        <VpcId>vpc-25dvz****</VpcId>
    </LoadBalancers>
    <MaxResults>50</MaxResults>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
    <TotalCount>1000</TotalCount>
</ListLoadBalancersResponse>

JSON格式

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

{
  "LoadBalancers" : [ {
    "AccessLogConfig" : {
      "LogProject" : "sls-setter",
      "LogStore" : "test"
    },
    "AddressAllocatedMode" : "Fixed",
    "AddressType" : "Internet",
    "BandwidthPackageId" : "cbwp-bp1vevu8h3ieh****",
    "CreateTime" : "2019-06-03T17:22Z",
    "DNSName" : "alb-95qnr2itwu9orb****.cn-hangzhou.alb.aliyuncs.com",
    "DeletionProtectionConfig" : {
      "Enabled" : true,
      "EnabledTime" : "2019-06-03T17:22Z"
    },
    "LoadBalancerBillingConfig" : {
      "PayType" : "PostPay"
    },
    "LoadBalancerBussinessStatus" : "Normal",
    "LoadBalancerEdition" : "Standard",
    "LoadBalancerId" : "lb-bp1b6c719dfa08ex****",
    "LoadBalancerName" : "lb-instance-test",
    "LoadBalancerOperationLocks" : [ {
      "LockReason" : "欠费",
      "LockType" : "FinancialLocked"
    } ],
    "LoadBalancerStatus" : "Active",
    "ModificationProtectionConfig" : {
      "Reason" : "托管实例",
      "Status" : "ConsoleProtection"
    },
    "ResourceGroupId" : "rg-atstuj3rtop****",
    "Tags" : [ {
      "Key" : "FinanceDept",
      "Value" : "FinanceJoshua"
    } ],
    "VpcId" : "vpc-25dvz****"
  } ],
  "MaxResults" : 50,
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId" : "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "TotalCount" : 1000
}

错误码

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