阅读941 返回首页    go 阿里云

DescribeLoadBalancers__LoadBalancer相关API_API 参考_负载均衡-阿里云

描述

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

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

请求参数

名称 类型 是否必须 描述
Action String 是 操作接口名，系统规定参数。取值：DescribeLoadBalancers
RegionId String 是 负载均衡实例所属的Region编号。
LoadBalancerId String 否 以负载均衡实例ID作为过滤器进行模糊搜索。支持多值查询。
取值：可以输入多个，以”,”分割
默认值：无。不设置该参数表示不使用该参数作为过滤条件。
LoadBalancerName String 否 以负载均衡实例名称作为过滤器进行模糊搜索。支持多值查询。
取值：可以输入多个，以”,”分割
默认值：无。不设置该参数表示不使用该参数作为过滤条件。
LoadBalancerId String 否 以负载均衡实例ID作为过滤器。支持多值查询。
取值：可以输入多个，以”,”分割
默认值：无。不设置该参数表示不使用该参数作为过滤条件。
AddressType String 否 以Address类型作为过滤器。
取值：internet / intranet。默认值：无
不设置该参数表示不使用该参数作为过滤条件。
NetworkType String 否 负载均衡实例网络类型，vpc或者classic。
VpcId String 否 负载均衡实例Vpcid。
VswitchId String 否 负载均衡实例Vswitchid。
Address String 否 负载均衡实例服务地址。
ServerIntranetAddress String 否 以绑定的后端服务器内网地址为过滤器进行模糊搜索。支持多值查询。
取值：可以输入多个，以”,”分割
默认值：无。不设置该参数表示不使用该参数作为过滤条件。
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 是 最多支持64个字
不支持aliyun开头
不允许为空
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 Integer 公网类型实例按固定带宽计费方式时设定的带宽峰值。
CreateTime String 负载均衡实例创建时间。
MasterZoneId String 该创建实例的主可用区ID。
SlaveZoneId String 该创建实例的备可用区ID。

示例

请求示例

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

返回示例

  • XML格式

    1.       <?xml version="1.0" encoding="UTF-8"?>
    2.       <DescribeLoadBalancersResponse>
    3.       <RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
    4.       <LoadBalancers>
    5.           <LoadBalancer>
    6.               <LoadBalancerId>139a00604ad-cn-east-hangzhou-01</LoadBalancerId>
    7.               <LoadBalancerName>abc</LoadBalancerName>
    8.               <Address>100.98.28.56</Address>
    9.               <AddressType>intranet</AddressType>
    10.               <RegionId>cn-east-hangzhou-01</RegionId>
    11.               <VSwitchId>vsw-255ecrwq4</VSwitchId>
    12.               <VpcId>vpc-25dvzy9f9</VpcId>
    13.               <NetworkType>vpc</NetworkType>
    14.               <LoadBalancerStatus>active</LoadBalancerStatus>
    15.               <MasterZoneId>cn-hangzhou-b<MasterZoneId>
    16.               <SlaveZoneId>cn-hangzhou-d<SlaveZoneId>
    17.           </LoadBalancer>
    18.           <LoadBalancer>
    19.               <LoadBalancerId>282b00102ac-cn-east-hangzhou-01</LoadBalancerId>
    20.               <LoadBalancerName>def</LoadBalancerName>
    21.               <Address>100.98.28.55</Address>
    22.               <AddressType>intranet</AddressType>
    23.               <RegionId>cn-east-hangzhou-01</RegionId>
    24.               <VSwitchId>vsw-255ecrwq5</VSwitchId>
    25.               <VpcId>vpc-25dvzy9f8</VpcId>
    26.               <NetworkType>vpc</NetworkType>
    27.               <LoadBalancerStatus>active</LoadBalancerStatus>
    28.               <MasterZoneId>cn-hangzhou-b<MasterZoneId>
    29.               <SlaveZoneId>cn-hangzhou-d<SlaveZoneId>
    30.           </LoadBalancer>
    31.       </LoadBalancers>
    32.   </DescribeLoadBalancersResponse>

  • JSON格式

    1.   {
    2.       "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
    3.       "LoadBalancers": {
    4.           "LoadBalancer": [
    5.               {
    6.                   "LoadBalancerId": "139a00604ad-cn-east-hangzhou-01",
    7.                   "LoadBalancerName": "abc",
    8.                   "Address": "100.98.28.56",
    9.                   "AddressType": "intranet",
    10.                   "RegionId": "cn-east-hangzhou-01",
    11.                   "VSwitchId": "vsw-255ecrwq4",
    12.                   "VpcId": "vpc-25dvzy9f9",
    13.                   "NetworkType": "vpc",
    14.                   "LoadBalancerStatus ": "active",
    15.                   "MasterZoneId":"cn-hangzhou-b",
    16.                   "SlaveZoneId":"cn-hangzhou-d"
    17.               },
    18.               {
    19.                   "LoadBalancerId": "282b00102ac-cn-east-hangzhou-01",
    20.                   "LoadBalancerName": "def",
    21.                   "Address": "100.98.28.55",
    22.                   "AddressType": "intranet",
    23.                   "RegionId": "cn-east-hangzhou-01",
    24.                   "VSwitchId": "vsw-255ecrwq5",
    25.                   "VpcId": "vpc-25dvzy9f8",
    26.                   "NetworkType": "vpc",
    27.                   "LoadBalancerStatus ": "active"
    28.                   "MasterZoneId":"cn-hangzhou-b",
    29.                   "SlaveZoneId":"cn-hangzhou-d"
    30.               }
    31.           ]
    32.       }
    33.   }

最后更新：2016-12-08 09:15:14

  上一篇：go SetLoadBalancerName__LoadBalancer相关API_API 参考_负载均衡-阿里云
  下一篇：go DescribeLoadBalancerAttribute__LoadBalancer相关API_API 参考_负载均衡-阿里云