使用DescribeLoadBalancers查詢已建立的Server Load Balancer執行個體列表-邊緣節點服務 ENS-阿里雲 - ENS

呼叫 DescribeLoadBalancers 查詢已建立的負載平衡執行個體清單資訊。

介面說明

API 呼叫頻率：100 次/秒。
單使用者呼叫頻率：10 次/秒。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

ens:DescribeLoadBalancers

list

*All Resource

*

無

請求參數

名稱	類型	必填	描述	樣本值
EnsRegionId	string	否	ENS 節點 ID。	cn-guangzhou-10
ServerId	string	否	後端伺服器執行個體 ID。	i-5f67ffjc004wwz0t****
LoadBalancerStatus	string	否	負載平衡執行個體監聽狀態。取值： Active：執行個體中的監聽可以根據規則轉發接收的流量。 InActive：執行個體中的監聽不會再轉發接收的流量。	InActive
LoadBalancerId	string	否	負載平衡執行個體的 ID。	lb-5q73cv04zeyh43lh74lp4****
LoadBalancerName	string	否	負載平衡執行個體名稱。	example
NetworkId	string	否	網路 ID。	n-5s9ayrxsd9hszrlt5fgv2****
VSwitchId	string	否	交換器 ID。	vsw-5sy773iy25rulsmgskmba****
Address	string	否	負載平衡執行個體的服務位址。	10.0.XX.XX
EnsRegionIds	array	否	ENS 節點 ID 清單。
	string	否	ENS 節點 ID。	cn-chengdu-telecom-4
PageNumber	integer	否	清單的頁碼，預設值：1。	1
PageSize	integer	否	分頁查詢時設定的每頁列數。預設值：10，取值：10~100。	100
LoadBalancerType	string	否	負載平衡執行個體類型。

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	清單的頁碼。	1
PageSize	integer	分頁查詢時設定的每頁列數。預設值：10，取值：10~100。	100
TotalCount	integer	清單項目數。	1
LoadBalancers	object
LoadBalancer	array<object>	陣列格式，返回負載平衡執行個體清單。
	object	陣列格式，返回負載平衡執行個體清單。
LoadBalancerId	string	Server Load Balancer 執行個體的 ID。	lb-5snthcyu1x10g7tywj7iu****
LoadBalancerName	string	Server Load Balancer 執行個體的名稱。	example
LoadBalancerStatus	string	Server Load Balancer 執行個體監聽狀態。取值： Active：執行個體中的監聽可以根據規則轉寄接收的流量。 InActive：執行個體中的監聽不會再轉寄接收的流量。	InActive
Address	string	Server Load Balancer 執行個體服務地址。	10.10.XX.XX
EnsRegionId	string	ENS 節點 ID。	cn-wuhan-telecom
NetworkId	string	網路識別碼。	n-5rz0rj1caexauilpsjx0w****
VSwitchId	string	交換器 ID。	vsw-5rllcjb3ol6duzjdnbm1om****
CreateTime	string	Server Load Balancer 執行個體建立時間（UTC）。	2021-05-06T11:13:41Z
AddressIPVersion	string	IP 版本。取值：ipv4 或者 ipv6。	ipv4
PayType	string	付費類型。取值： PrePaid：預付費。 PostPaid（目前僅支援該付費類型）：後付費。	PostPaid
LoadBalancerType	string
AddressType	string

樣本

正常返回樣本

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "PageSize": 100,
  "TotalCount": 1,
  "LoadBalancers": {
    "LoadBalancer": [
      {
        "LoadBalancerId": "lb-5snthcyu1x10g7tywj7iu****",
        "LoadBalancerName": "example",
        "LoadBalancerStatus": "InActive",
        "Address": "10.10.XX.XX",
        "EnsRegionId": "cn-wuhan-telecom",
        "NetworkId": "n-5rz0rj1caexauilpsjx0w****",
        "VSwitchId": "vsw-5rllcjb3ol6duzjdnbm1om****",
        "CreateTime": "2021-05-06T11:13:41Z",
        "AddressIPVersion": "ipv4",
        "PayType": "PostPaid",
        "LoadBalancerType": "",
        "AddressType": ""
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	ens.interface.error	Failed to call API.
400	NoPermission	Permission denied.
400	Invalid%s	The specified parameter %s is invalid.
400	Missing%s	You must specify the parameter %s.

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

變更歷史

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