更新时间:2024-04-08 GMT+08:00

查询监听器列表

功能介绍

查询监听器列表信息。

URI

GET /v1.0/{project_id}/elbaas/listeners?loadbalancer_id={loadbalancer_id}

可以在URI后面用‘?’和‘&’添加不同的查询条件组合。支持除update_time、create_time、admin_state_up、session_sticky和member_number之外所有响应要素过滤。

表1 参数说明

参数

是否必选

参数类型

描述

project_id

String

操作用户的项目ID。

loadbalancer_id

String

所属负载均衡器ID。

请求消息

  • 请求参数

  • 请求样例

响应消息

  • 响应参数
    表2 响应参数

    参数

    参数类型

    描述

    update_time

    String

    更新时间。

    backend_port

    Integer

    后端端口。

    id

    String

    监听器ID。

    backend_protocol

    String

    后端协议。

    sticky_session_type

    String

    cookie的处理方式,设置为insert表示由ELB插入。protocol为HTTP,session_sticky为true时有效,且默认insert方式。protocol为TCP时,此参数无效(不传或者为空)。

    description

    String

    描述。

    loadbalancer_id

    String

    所属负载均衡器ID。

    create_time

    String

    创建时间。

    status

    String

    监听器状态。状态值:ACTIVE,PENDING_CREATE,ERROR。

    protocol

    String

    监听协议,用于区分四层和七层。

    lb_algorithm

    String

    监听器负载均衡方式。

    admin_state_up

    Boolean

    • 弹性负载均衡器的管理状态,
    • 取值范围:

      false:停用。

      true:正常。

    cookie_timeout

    Integer

    • cookie超时时间。session_sticky为true时且sticky_session_type为insert有效。
    • 取值范围:1-1440(单位为分)。

    member_number

    Integer

    后端云服务器个数。

    healthcheck_id

    String

    健康检查ID。

    session_sticky

    Boolean

    是否开启会话保持。true为开启会话保持,false为关闭会话保持。

    port

    Integer

    监听端口。

    name

    String

    监听器的名称。

    certificate_id

    String

    用于安全认证的SSL证书的ID。如果protocol为HTTPS或SSL,该字段为必选字段,否则返回值为null。

    tcp_timeout

    Integer

    TCP请求会话保持超时时间。

    udp_timeout

    Integer

    UDP请求会话保持超时时间。

    ssl_protocols

    String

    监听器支持的SSL协议标准,用于启动特定的加密协议。该字段仅protocol为HTTPS时返回。

    说明:

    1.2.8版本前已有HTTPS协议类型的监听器如果该字段未修改,则值为TLS 1.2。

    ssl_ciphers

    String

    加密协议的加密套件。该字段仅protocol为HTTPS时返回。

  • 响应样例
    [
     {
         "update_time": "2016-12-01 07:12:59",
         "backend_port": 9090,
         "id": "a824584fb3ba4d39ba0cf372c7cbbb67",
         "backend_protocol": "TCP",
         "sticky_session_type": null,
         "certificate_id": null,
         "description": "",
         "loadbalancer_id": "f54c65b1b5dd4a4f95b71b44796ac013",
         "lb_algorithm": "roundrobin",
         "create_time": "2016-12-01 07:12:43",
         "admin_state_up": false,
         "status": "ACTIVE",
         "protocol": "TCP",
         "cookie_timeout": 100,
         "port": 9092,
         "tcp_draining": true,
         "tcp_timeout": 1,
         "member_number": 0,
         "healthcheck_id": null,
         "session_sticky": true,
         "tcp_draining_timeout": 5,
         "name": "lis"
    },
    
    {
         "update_time": "2016-12-01 07:11:49",
         "backend_port": 9090,
         "id": "4818300858fc43e0a4d843ce74ee83a4",
         "backend_protocol": "HTTP",
         "sticky_session_type": "insert",
         "certificate_id": null,
         "description": "",
         "loadbalancer_id": "f54c65b1b5dd4a4f95b71b44796ac013",
         "lb_algorithm": "roundrobin",
         "create_time": "2016-12-01 07:11:30",
         "admin_state_up": false,
         "status": "ACTIVE",
         "protocol": "HTTP",
         "cookie_timeout": 100,
         "port": 9091,
         "tcp_draining": true,
         "tcp_timeout": null,
         "member_number": 0,
         "healthcheck_id": null,
         "session_sticky": true,
         "tcp_draining_timeout": 5,
         "name": "lis"
     }
    ]

状态码

  • 正常

    200

  • 异常

    状态码

    编码

    错误码说明

    400

    badRequest

    请求错误

    401

    unauthorized

    鉴权失败

    403

    userDisabled

    没有权限

    404

    Not Found

    请求的页面不存在

    500

    authFault

    内部错误

    503

    serviceUnavailable

    服务不可用