DescribeLoadBalancers_实例相关API_API 参考_开发指南

描述

查询用户创建的所有LoadBalancer列表。

查询时，可使用LoadBalancerId、AddressTypee、ServerId、Tag等参数作为查询条件。如果未使用以上任何一个查询条件作为过滤器，则返回用户拥有的所有LoadBalancer。

请求参数

名称	类型	是否必须	描述
Action	String	是	操作接口名，系统规定参数。取值：DescribeLoadBalancers。
RegionId	String	是	负载均衡实例所属的Region编号。
LoadBalancerId	String	否	以负载均衡实例ID作为过滤器进行模糊搜索。支持多值查询。取值：可以输入多个，以”,”分割。默认值：无。不设置该参数表示不使用该参数作为过滤条件。
LoadBalancerName	String	否	以负载均衡实例名称作为过滤器进行模糊搜索。支持多值查询。取值：可以输入多个，以”,”分割。默认值：无。不设置该参数表示不使用该参数作为过滤条件。
AddressType	String	否	以Address类型作为过滤器。取值：internet / intranet。默认值：无。不设置该参数表示不使用该参数作为过滤条件。
NetworkType	String	否	负载均衡实例网络类型，vpc或者classic。
VpcId	String	否	负载均衡实例所属的VPC ID。
VswitchId	String	否	负载均衡实例所属的VSwitch ID。
Address	String	否	负载均衡实例的服务地址。
ServerIntranetAddress	Integer	否	绑定的后端服务器内网地址为过滤器进行模糊搜索。支持多值查询。取值：可以输入多个，以逗号（,）分割。默认值：无。不设置该参数表示不使用该参数作为过滤条件。
InternetChargeType	String	否	以公网类型实例付费方式作为过滤器。取值：paybybandwidth / paybytraffic。默认值：无。不设置该参数表示不使用该参数作为过滤条件
ServerId	String	否	以后端服务器名称ID（ECS实例ID）作为过滤器。若使用该条件，则只返回挂载了此服务器的负载均衡实例。取值：ECS实例ID。默认值：无。不设置该参数表示不使用该参数作为过滤条件。
MasterZoneId	String	否	该创建实例的主可用区ID。通过DescribeZone接口可查到相应Region下的主备可用区信息。目前对金融云用户暂时不支持多可用区功能。
SlaveZoneId	String	否	该创建实例的备可用区ID。通过DescribeZone接口可查到相应Region下的主备可用区信息。目前对金融云用户暂时不支持多可用区功能。
Tags	String	否	需要添加的Tag列表。取值：是一个Json string，其结构是一个JsonList。一次请求中，List中的元素个数最多10个。List元素的结构详见下表。

Tags元素

名称	类型	是否必须	描述
TagKey	String	是	操作接口名，系统规定参数。取值：DeleteLoadBalancer。
TagValue	String	否	最多支持128个字符。不支持aliyun开头。

返回参数

名称	类型	描述
<公共参数>		详见 <公共返回参数>。
LoadBalancers	List	数组格式，返回负载均衡实例列表，详情见下表。

负载均衡实例列表LoadBalancers

名称	类型	描述
LoadBalancerId	String	负载均衡实例的唯一标识。
LoadBalancerName	String	负载均衡实例别名。
LoadBalancerStatus	String	负载均衡实例状态，inactive、active或者locked。locked状态表示实例已经欠费或被阿里云锁定，需要续费开通或联系阿里云官方解锁。
Address	String	负载均衡实例服务地址。
RegionId	String	负载均衡实例所属的Region编号。
RegionIdAlias	String	负载均衡实例所属的Region编号别名，和DescribeRegions返参一致。
AddressType	String	负载均衡实例地址类型。
VSwitchId	String	负载均衡实例Vswitchid，只有在NetworkType为VPC时才有值。
VpcId	String	负载均衡实例Vpcid，只有在NetworkType为VPC时才有值。
NetworkType	String	负载均衡实例网络类型，vpc或者classic。
Bandwidth	String	公网类型实例按固定带宽计费方式时设定的带宽峰值。
CreateTime	String	负载均衡实例创建时间。
MasterZoneId	String	该创建实例的主可用区ID。
SlaveZoneId	String	该创建实例的备可用区ID。

示例

请求示例

https://slb.aliyuncs.com/
    &Action=DescribeLoadBalancers
    &RegionId=cn-east-hangzhou-01
    &LoadBalancerId=139a00604ad-cn-east-hangzhou-01, 282b00102ac-cn-east-hangzhou-01&<公共请求参数>

返回示例

XML格式

      <?xml version="1.0" encoding="UTF-8"?>
      <DescribeLoadBalancersResponse>
      <RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
      <LoadBalancers>
          <LoadBalancer>
              <LoadBalancerId>139a00604ad-cn-east-hangzhou-01</LoadBalancerId>
              <LoadBalancerName>abc</LoadBalancerName>
              <Address>100.98.28.56</Address>
              <AddressType>intranet</AddressType>
              <RegionId>cn-east-hangzhou-01</RegionId>
              <VSwitchId>vsw-255ecrwq4</VSwitchId>
              <VpcId>vpc-25dvzy9f9</VpcId>
              <NetworkType>vpc</NetworkType>
              <LoadBalancerStatus>active</LoadBalancerStatus>
              <MasterZoneId>cn-hangzhou-b<MasterZoneId>
              <SlaveZoneId>cn-hangzhou-d<SlaveZoneId>
          </LoadBalancer>
          <LoadBalancer>
              <LoadBalancerId>282b00102ac-cn-east-hangzhou-01</LoadBalancerId>
              <LoadBalancerName>def</LoadBalancerName>
              <Address>100.98.28.55</Address>
              <AddressType>intranet</AddressType>
              <RegionId>cn-east-hangzhou-01</RegionId>
              <VSwitchId>vsw-255ecrwq5</VSwitchId>
              <VpcId>vpc-25dvzy9f8</VpcId>
              <NetworkType>vpc</NetworkType>
              <LoadBalancerStatus>active</LoadBalancerStatus>
              <MasterZoneId>cn-hangzhou-b<MasterZoneId>
              <SlaveZoneId>cn-hangzhou-d<SlaveZoneId>
          </LoadBalancer>
      </LoadBalancers>
  </DescribeLoadBalancersResponse>

JSON格式

  {
      "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
      "LoadBalancers": {
          "LoadBalancer": [
              {
                  "LoadBalancerId": "139a00604ad-cn-east-hangzhou-01",
                  "LoadBalancerName": "abc",
                  "Address": "100.98.28.56",
                  "AddressType": "intranet",
                  "RegionId": "cn-east-hangzhou-01",
                  "VSwitchId": "vsw-255ecrwq4",
                  "VpcId": "vpc-25dvzy9f9",
                  "NetworkType": "vpc",
                  "LoadBalancerStatus ": "active",
                  "MasterZoneId":"cn-hangzhou-b",
                  "SlaveZoneId":"cn-hangzhou-d"
              },
              {
                  "LoadBalancerId": "282b00102ac-cn-east-hangzhou-01",
                  "LoadBalancerName": "def",
                  "Address": "100.98.28.55",
                  "AddressType": "intranet",
                  "RegionId": "cn-east-hangzhou-01",
                  "VSwitchId": "vsw-255ecrwq5",
                  "VpcId": "vpc-25dvzy9f8",
                  "NetworkType": "vpc",
                  "LoadBalancerStatus ": "active"
                  "MasterZoneId":"cn-hangzhou-b",
                  "SlaveZoneId":"cn-hangzhou-d"
              }
          ]
      }
  }