调用DescribeLoadBalancers接口查询负载均衡实例列表-边缘节点服务 ENS-阿里云-边缘节点服务 ENS(ENS)-阿里云帮助中心

调用DescribeLoadBalancers查询已创建的负载均衡实例列表信息。

接口说明

API 调用频率：100 次/秒。
单用户调用频率：10 次/秒。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ens:DescribeLoadBalancers

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
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	负载均衡实例的 ID。	lb-5snthcyu1x10g7tywj7iu****
LoadBalancerName	string	负载均衡实例的名称。	example
LoadBalancerStatus	string	负载均衡实例监听状态。取值： Active：实例中的监听可以根据规则转发接收的流量。 InActive：实例中的监听不会再转发接收的流量。	InActive
Address	string	负载均衡实例服务地址。	10.10.XX.XX
EnsRegionId	string	ENS 节点 ID。	cn-wuhan-telecom
NetworkId	string	网络 ID。	n-5rz0rj1caexauilpsjx0w****
VSwitchId	string	交换机 ID。	vsw-5rllcjb3ol6duzjdnbm1om****
CreateTime	string	负载均衡实例创建时间（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.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。