DescribeLoadBalancerListeners - 查询负载均衡监听列表

调用DescribeLoadBalancerListeners查询负载均衡实例监听列表。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
LoadBalancerIdstring

负载均衡实例的 ID。

lb-5s7crik3yo3p5****
PageNumberinteger

当前页码。

1
PageSizeinteger

分页查询时每页的行数。

10
ListenerPortinteger

负载均衡实例前端使用的端口。取值:1~65535

80
Descriptionstring

监听的描述信息。

test

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

F3B261DD-3858-4D3C-877D-303ADF374600
PageNumberinteger

当前页码。

1
PageSizeinteger

分页查询时每页的行数。

10
TotalCountinteger

总记录数。

49
Listenersarray<object>

负载均衡的监听列表。

Listenerobject

负载均衡的监听列表。

LoadBalancerIdstring

负载均衡实例 ID。

lb-51a5fhou****
ListenerPortstring

监听端口。

8080
Protocolstring

监听的网络传输协议类型。

  • tcp:TCP 监听。
  • udp:UDP 监听。
  • http:UDP 监听。
  • https:UDP 监听。
tcp
Descriptionstring

监听描述。

test
Statusstring

监听的状态。取值:

  • running:表示监听正常运行。
  • stopped:表示监听运行停止。
running
ListenerForwardstring

是否开启 HTTP 至 HTTPS 监听转发。取值:

  • on:是
  • off:否
off
ForwardPortstring

HTTP 转发至 HTTPS 的监听端口。

443
CreateTimestring

监听创建时间的时间戳。

2022-08-15T08:42:57Z
BackendServerPortinteger

负载均衡实例后端服务器使用的端口,取值:1~65535

3306

示例

正常返回示例

JSON格式

{
  "RequestId": "F3B261DD-3858-4D3C-877D-303ADF374600",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 49,
  "Listeners": {
    "Listener": [
      {
        "LoadBalancerId": "lb-51a5fhou****",
        "ListenerPort": 8080,
        "Protocol": "tcp",
        "Description": "test",
        "Status": "running",
        "ListenerForward": "off",
        "ForwardPort": 443,
        "CreateTime": "2022-08-15T08:42:57Z",
        "BackendServerPort": 3306
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400ens.interface.errorFailed to call API.接口调用发生异常。
400LoadBalancerNotFoundThe input parameter LoadBalancerId that is not found.负载均衡实例不存在
400NoPermissionPermission denied.没有足够的权限,请联系云账号管理员授予您相应权限。
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

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

变更历史

变更时间变更内容概要操作
2025-02-11OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情