閱讀941 返回首頁    go 阿裏雲 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 參考_負載均衡-阿裏雲