ListLoadBalancers - 查詢Server Load Balancer執行個體列表 - Server Load Balancer

查詢Server Load Balancer執行個體列表。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

gwlb:ListLoadBalancers

list

LoadBalancer

acs:gwlb:{#regionId}:{#accountId}:loadbalancer/*

LoadBalancer

acs:gwlb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

VPC

acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}

無

請求參數

名稱	類型	必填	描述	樣本值
ZoneIds	array	否	可用性區域 ID 列表。一次最多支援查詢 20 個可用性區域 ID。
	string	否	可用性區域 ID。	cn-beijing-h
VpcIds	array	否	專用網路 ID 列表。一次最多支援查詢 20 個 VPC ID。
	string	否	專用網路識別碼。	vpc-bp1xuejaht4o7yhh2****
AddressIpVersion	string	否	協議版本。取值： Ipv4：Ipv4 類型。枚舉值： IPv4 : IPv4 DualStack : DualStack	Ipv4
LoadBalancerStatus	string	否	網關型負載平衡的執行個體狀態。取值： Active：運行中。 Inactive：已停止，表示執行個體監聽不會再轉寄流量。 Provisioning：建立中。 Configuring：變更配置中。	Active
LoadBalancerBusinessStatus	string	否	網關型負載平衡的業務狀態。取值： Normal：正常狀態。 FinancialLocked：欠費鎖定狀態。	Normal
LoadBalancerNames	array	否	網關型Server Load Balancer執行個體名稱列表。一次最多支援查詢 20 個執行個體名稱。
	string	否	網路型Server Load Balancer執行個體名稱。	testGwlbName
ResourceGroupId	string	否	資源群組 ID。	rg-aek2htf5qsyrn****
LoadBalancerIds	array	否	網關型Server Load Balancer執行個體的 ID 列表。一次最多支援查詢 20 個執行個體。
	string	否	網關型Server Load Balancer執行個體的 ID。	gwlb-cp6prgqy40hols****
TrafficMode	string	否	流量模式。取值： LoadBalance：負載平衡。 ByPass：繞行模式。	LoadBalance
Tag	array<object>	否	標籤列表。一次調用最多支援 20 個標籤。
	object	否	標籤資訊對象。
Key	string	否	標籤鍵。一旦傳入該值，則不允許為空白字串。一個標籤健最多支援 128 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	testTagKey
Value	string	否	標籤值。最多支援 256 個字元，不能包含`http://`或`https://`。	testTagValue
NextToken	string	否	是否擁有下一次查詢的令牌（Token）。取值：如果 NextToken 為空白表示沒有下一次查詢。如果 NextToken 有傳回值，該取值表示下一次查詢開始的令牌。	WyJyb290IiwibiIsIm4iLDEsMCwxNjg1MDY1NTgyNzYwLCI2NDcwMGY2ZTc2Zjc0MWFiZGEyZjQyNzc4ZDk2MmJkOTk3ZGZmM2Nm****
MaxResults	integer	否	分批次查詢時每次顯示的條目數。取值範圍：1~1000，預設值：20。	20
Skip	integer	否	查詢時跳過指定的條目數。	1

返回參數

名稱	類型	描述	樣本值
	object
LoadBalancers	array<object>	網關型Server Load Balancer執行個體列表。
	array<object>	網關型Server Load Balancer執行個體對象。
AddressIpVersion	string	協議版本。取值： IPv4：IPv4 類型。	IPv4
CreateTime	string	資源建立時間，使用格林威治時間，格式為yyyy-MM-ddTHH:mm:ssZ。	2024-08-05T18:24:07Z
LoadBalancerBusinessStatus	string	網關型負載平衡的業務狀態。取值： Normal：正常狀態。 FinancialLocked：欠費鎖定狀態。	Normal
LoadBalancerId	string	網關型Server Load Balancer執行個體的 ID。	gwlb-9njtjmqt7zfcqm****
LoadBalancerName	string	網關型Server Load Balancer執行個體名稱。長度為 2~128 個英文或中文字元，必須以字母或中文開頭，可包含數字、半形句號（.）、底線（_）和短劃線（-）。	testGwlbName
LoadBalancerStatus	string	網關型負載平衡的執行個體狀態。取值： Active：運行中。 Inactive：已停止，表示執行個體監聽不會再轉寄流量。 Provisioning：建立中。 Configuring：變更配置中。	Active
ResourceGroupId	string	資源群組 ID。	rg-aek26jasguy****
Tags	array<object>	標籤列表。
	object	標籤對象。
Key	string	標籤鍵。一旦傳入該值，則不允許為空白字串。一個標籤健最多支援 128 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	testTagKey
Value	string	標籤值。最多支援輸入 20 個標籤值。一旦傳入該值，可以為空白字串。一個標籤值最多支援 128 個字元，必須以字母或中文開頭，可包含數字、半形句號（.）、底線（_）和短劃線（-），不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	testTagValue
VpcId	string	專用網路識別碼。	vpc-uf6eg0vndlsa84n7r****
ZoneMappings	array<object>	可用性區域及交換器映射列表。至少需要添加一個可用性區域，最多支援添加 20 個可用性區域。若當前地區支援 2 個及以上的可用性區域，建議添加 2 個及以上可用性區域。
	array<object>	可用性區域及交換器映射對象。
LoadBalancerAddresses	array<object>	網關型Server Load Balancer執行個體地址清單。
	object	網關型Server Load Balancer執行個體地址對象。
EniId	string	彈性網卡 ENI ID。	eni-bp17qv9zbzyqy629****
PrivateIpv4Address	string	IPv4 私網地址。	192.168.XX.XX
VSwitchId	string	可用性區域對應的交換器，每個可用性區域預設使用一台交換器和一個子網。	vsw-2zemule5dz7okwqfv****
ZoneId	string	可用性區域 ID，通過調用網關型負載平衡 DescribeZones 介面獲得。	cn-hangzhou-g
MaxResults	integer	分批次查詢時每次顯示的條目數。取值範圍：1~1000，預設值：20。	20
NextToken	string	是否擁有下一次查詢的令牌（Token）。取值：第一次查詢和沒有下一次查詢時，均無需填寫。如果有下一次查詢，取值為上一次 API 呼叫返回的 NextToken 值。	CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAIldD2UAAAAACjMDLgAAADFTNzMyZDMwMzAzMDY5NzQzNDM0NmI3NzM2NjUzNzc4NzM2YTc0NjYzOTYz****
RequestId	string	請求 ID。	378A80E9-4262-5D8E-8D62-0969E52D7358
TotalCount	integer	列表條目總數。	100

樣本

正常返回樣本

JSON格式

{
  "LoadBalancers": [
    {
      "AddressIpVersion": "IPv4",
      "CreateTime": "2024-08-05T18:24:07Z",
      "LoadBalancerBusinessStatus": "Normal",
      "LoadBalancerId": "gwlb-9njtjmqt7zfcqm****",
      "LoadBalancerName": "testGwlbName",
      "LoadBalancerStatus": "Active",
      "ResourceGroupId": "rg-aek26jasguy****",
      "Tags": [
        {
          "Key": "testTagKey",
          "Value": "testTagValue"
        }
      ],
      "VpcId": "vpc-uf6eg0vndlsa84n7r****",
      "ZoneMappings": [
        {
          "LoadBalancerAddresses": [
            {
              "EniId": "eni-bp17qv9zbzyqy629****",
              "PrivateIpv4Address": "192.168.XX.XX"
            }
          ],
          "VSwitchId": "vsw-2zemule5dz7okwqfv****",
          "ZoneId": "cn-hangzhou-g"
        }
      ]
    }
  ],
  "MaxResults": 20,
  "NextToken": "CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAIldD2UAAAAACjMDLgAAADFTNzMyZDMwMzAzMDY5NzQzNDM0NmI3NzM2NjUzNzc4NzM2YTc0NjYzOTYz****",
  "RequestId": "378A80E9-4262-5D8E-8D62-0969E52D7358",
  "TotalCount": 100
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。