开发者社区 问答 正文

DescribeLoadBalancers


描述


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

请求参数


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            

名称类型是否必须描述
ActionString操作接口名,系统规定参数。取值:DescribeLoadBalancers。
RegionIdString负载均衡实例所属的Region编号。
LoadBalancerIdString以负载均衡实例ID作为过滤器进行模糊搜索。支持多值查询。取值:可以输入多个,以”,”分割。 默认值:无。不设置该参数表示不使用该参数作为过滤条件。
LoadBalancerName String以负载均衡实例名称作为过滤器进行模糊搜索。支持多值查询。取值:可以输入多个,以”,”分割。 默认值:无。不设置该参数表示不使用该参数作为过滤条件。
AddressTypeString以Address类型作为过滤器。取值:internet / intranet。默认值:无。不设置该参数表示不使用该参数作为过滤条件。
NetworkType String负载均衡实例网络类型,vpc或者classic。
VpcIdString负载均衡实例所属的VPC ID。
VswitchId String负载均衡实例所属的VSwitch ID。
AddressString负载均衡实例的服务地址。
ServerIntranetAddressInteger绑定的后端服务器内网地址为过滤器进行模糊搜索。支持多值查询。取值:可以输入多个,以逗号(,)分割。默认值:无。不设置该参数表示不使用该参数作为过滤条件。
InternetChargeType String以公网类型实例付费方式作为过滤器。取值:paybybandwidth / paybytraffic。默认值:无 。不设置该参数表示不使用该参数作为过滤条件
ServerIdString以后端服务器名称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元素
                                                                                                                                        
名称类型是否必须描述
TagKeyString操作接口名,系统规定参数。 取值:DeleteLoadBalancer。
TagValueString最多支持128个字符。不支持aliyun开头。


返回参数


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

负载均衡实例列表LoadBalancers
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
名称类型描述
LoadBalancerIdString负载均衡实例的唯一标识。
LoadBalancerNameString负载均衡实例别名。
LoadBalancerStatusString负载均衡实例状态,inactive、active或者locked。locked状态表示实例已经欠费或被阿里云锁定,需要续费开通或联系阿里云官方解锁。
AddressString负载均衡实例服务地址。
RegionIdString负载均衡实例所属的Region编号。
RegionIdAliasString负载均衡实例所属的Region编号别名,和DescribeRegions返参一致。
AddressTypeString负载均衡实例地址类型。
VSwitchIdString负载均衡实例Vswitchid,只有在NetworkType为VPC时才有值。
VpcIdString负载均衡实例Vpcid,只有在NetworkType为VPC时才有值。
NetworkTypeString负载均衡实例网络类型,vpc或者classic。
BandwidthString公网类型实例按固定带宽计费方式时设定的带宽峰值。
CreateTimeString负载均衡实例创建时间。
MasterZoneIdString该创建实例的主可用区ID。
SlaveZoneIdString该创建实例的备可用区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.   }

展开
收起
行者武松 2017-10-18 10:39:00 2163 分享 版权
0 条回答
写回答
取消 提交回答