查询监听器列表

功能介绍

查询监听器列表。支持过滤查询和分页查询。如未特殊说明，匹配规则为精确匹配。

可以通过监听器ID、协议类型、监听端口号、关联的后端云服务器的IP等查询监听器。

URI

GET /v2/{project_id}/elb/listeners

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	操作用户的项目ID。

表2 查询参数
参数	是否必选	参数类型	描述
marker	否	String	分页查询的起始的资源ID，表示上一页最后一条查询记录的监听器的ID。必须与limit一起使用。
limit	否	Integer	分页查询每页的监听器个数。如果不设置，则默认不分页查询所有。
page_reverse	否	Boolean	分页的顺序，true表示从后往前分页，false表示从前往后分页，默认为false。必须与limit一起使用。
id	否	String	监听器 ID。
name	否	String	监听器名称。支持的最大字符长度：255
description	否	String	监听器的描述信息。支持的最大字符长度：255
loadbalancer_id	否	String	监听器所在的负载均衡器ID。
connection_limit	否	Integer	监听器的最大连接数。
admin_state_up	否	Boolean	监听器的管理状态。该字段为预留字段，暂未启用。默认为true。
default_pool_id	否	String	监听器的默认后端云服务器组ID。当请求没有匹配的转发策略时，转发到默认后端云服务器上处理。
http2_enable	否	Boolean	HTTP2功能的开启状态。取值范围：true/false。true：开启。false：关闭。
default_tls_container_ref	否	String	监听器使用的服务器证书ID。
client_ca_tls_container_ref	否	String	监听器使用的CA证书ID。
protocol	否	String	监听器的监听协议。取值范围：TCP、HTTP、UDP、TERMINATED_HTTPS。
protocol_port	否	Integer	监听器的监听端口。
enterprise_project_id	否	String	企业项目ID，仅用于基于企业项目的细粒度鉴权使用。如果参数传递default_pool_id，则以pool对应的企业项目ID鉴权。如果default_pool_id和enterprise_project_id都没有传递，则进行细粒度鉴权，必须在用户组下分配elb:*list权限才能通过鉴权。

请求消息

无

响应消息

表3 响应参数
参数	参数类型	描述
listeners	Array of Listeners objects	监听器对象列表。详见表4。

表4 listener字段说明
参数	参数类型	描述
id	String	监听器ID。
tenant_id	String	监听器所在的项目ID。支持的最大字符长度：255
name	String	监听器名称。支持的最大字符长度：255
description	String	监听器描述信息。支持的最大字符长度：255
protocol	String	监听器的监听协议。支持TCP、HTTP、UDP、TERMINATED_HTTPS。
protocol_port	Integer	监听器的监听端口。取值范围：[1, 65535]。
loadbalancers	Array of Loadbalancers objects	监听器关联的负载均衡器 ID。详细参见表6。
connection_limit	Integer	监听器的最大连接数。取值范围：[-1, 2147483647]。默认为-1，无连接数限制。该字段为预留字段，暂未启动。
admin_state_up	Boolean	监听器的管理状态。该字段为预留字段，暂未启用。取值范围：true/false。 true表示开启。 false表示关闭。
http2_enable	Boolean	HTTP2功能的开启状态。取值范围：true/false。true：开启。false：关闭。仅针对监听器的协议为TERMINATED_HTTPS有意义。
default_pool_id	String	监听器的默认后端云服务器组ID。当请求没有匹配的转发策略时，转发到默认后端云服务器上处理。当该字段为null时，表示监听器无默认的后端云服务器组。
default_tls_container_ref	String	监听器使用的服务器证书ID。详细参见SSL证书管理。当protocol参数为TERMINATED_HTTPS时，为必选字段。支持的最大字符长度：128
client_ca_tls_container_ref	String	监听器使用的CA证书ID。支持的最大字符长度：128 详细参见SSL证书管理。
sni_container_refs	Array	监听器使用的SNI证书（带域名的服务器证书）ID的列表。该字段不为空列表时，SNI特性开启。该字段为空列表时，SNI特性关闭。
tags	Array	监听器的标签。
created_at	String	监听器的创建时间。YYYY-MM-DDTHH:MM:SS
updated_at	String	监听器的更新时间。YYYY-MM-DDTHH:MM:SS

表5 loadbalancers字段说明
参数	是否必选	参数类型	描述
id	是	String	关联的负载均衡器id

请求示例

请求样例1 查询全量监听器

GET https://{Endpoint}/v2/601240b9c5c94059b63d484c92cfe308/elb/listeners

请求样例2 查询协议类型为UDP的监听器

GET https://{Endpoint}/v2/601240b9c5c94059b63d484c92cfe308/elb/listeners?protocol=UDP

响应示例

响应样例1

{
    "listeners": [
        {
            "client_ca_tls_container_ref": null,
            "protocol": "TCP",
            "description": "",
            "default_tls_container_ref": null,
            "admin_state_up": true,
            "http2_enable": false,
            "loadbalancers": [
                {
                    "id": "bc7ba445-035a-4464-a1a3-a62cf4a14116"
                }
            ],
            "tenant_id": "601240b9c5c94059b63d484c92cfe308",
 
            "sni_container_refs": [],       
 
            "connection_limit": -1,
            "protocol_port": 80,
            "default_pool_id": "ed75f16e-fcc6-403e-a3fb-4eae82005eab",
            "id": "75045172-70e9-480d-9443-b8b6459948f7",
            "tags": [],
            "name": "listener-cb2n",
            "created_at": "2018-07-25T01:54:13", 
            "updated_at": "2018-07-25T01:54:14"
  
        },
        {
            "client_ca_tls_container_ref": null,
            "protocol": "TCP",
            "description": "",
            "default_tls_container_ref": null,
            "admin_state_up": true,
            "http2_enable": false,
            "loadbalancers": [
                {
                    "id": "165b6a38-5278-4569-b747-b2ee65ea84a4"
                }
            ],
            "tenant_id": "601240b9c5c94059b63d484c92cfe308",
            "sni_container_refs": [],           
 
            "connection_limit": -1,
            "protocol_port": 8080,
            "default_pool_id": null,
            "id": "dada0003-7b0e-4de8-a4e1-1e937be2ba14",
            "tags": [],
            "name": "lsnr_name_mod",
            "created_at": "2018-07-25T01:54:13", 
            "updated_at": "2018-07-25T01:54:14"
        }
    ]
}

响应样例2

{
    "listeners": [
        {
            "insert_headers": null,
            "protocol_port": 64809,
            "protocol": "UDP",
            "description": "",
            "default_tls_container_ref": null,
            "sni_container_refs": [],
            "loadbalancers": [
                {
                    "id": "c1127125-64a9-4394-a08a-ef3be8f7ef9c"
                }
            ],
            "tenant_id": "601240b9c5c94059b63d484c92cfe308",
 
            "created_at": "2018-11-29T13:56:21",
            "client_ca_tls_container_ref": null,
            "connection_limit": -1,
            "updated_at": "2018-11-29T13:56:22",
            "http2_enable": false,
 
            "admin_state_up": true,
            "default_pool_id": "2f6895be-019b-4c82-9b53-c4a2ac009e20",
            "id": "5c63d176-444f-4c75-9cfe-bcb8a05a845c",
            "tags": [],
            "name": "listener-tvp8"
        }
    ]
}

返回码

请参见状态码。

父主题： 监听器

上一篇：查询监听器详情

下一篇：更新监听器

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消