查询监听器列表

功能介绍

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

可以通过监听器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权限才能通过鉴权。
tls_ciphers_policy	否	String	监听器使用的安全策略，仅对TERMINATED_HTTPS协议类型的监听器有效，且默认值为tls-1-0。取值包括：tls-1-0-inherit，tls-1-0, tls-1-1, tls-1-2, tls-1-2-strict多种安全策略。各安全策略使用的加密套件列表详细参见表3。

表3 tls_ciphers_policy取值说明
安全策略	支持的TLS版本类型	使用的加密套件列表
tls-1-0-inherit	TLS 1.2 TLS 1.1 TLS 1.0	ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:AES128-SHA256:AES256-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:DHE-RSA-AES128-SHA:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:AES128-SHA:AES256-SHA:DHE-DSS-AES128-SHA:CAMELLIA128-SHA:EDH-RSA-DES-CBC3-SHA:DES-CBC3-SHA:ECDHE-RSA-RC4-SHA:RC4-SHA:DHE-RSA-AES256-SHA:DHE-DSS-AES256-SHA:DHE-RSA-CAMELLIA256-SHA:DHE-DSS-CAMELLIA256-SHA:CAMELLIA256-SHA:EDH-DSS-DES-CBC3-SHA:DHE-RSA-CAMELLIA128-SHA:DHE-DSS-CAMELLIA128-SHA
tls-1-0	TLS 1.2 TLS 1.1 TLS 1.0	ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:AES128-SHA256:AES256-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:AES128-SHA:AES256-SHA
tls-1-1	TLS 1.2 TLS 1.1
tls-1-2	TLS 1.2
tls-1-2-strict	TLS 1.2	ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:AES128-SHA256:AES256-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384

请求消息

无

响应消息

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

表5 listener字段说明
参数	参数类型	描述
id	String	监听器ID。
tenant_id	String	监听器所在的项目ID。支持的最大字符长度：255
project_id	String	此参数和tenant_id参数含义一样，均指监听器所在的项目ID。
name	String	监听器名称。注意：若名称为空，则在控制台的监听器列表无法选择并查看监听器详情。支持的最大字符长度：255
description	String	监听器描述信息。支持的最大字符长度：255
protocol	String	监听器的监听协议。支持TCP、HTTP、UDP、TERMINATED_HTTPS。
protocol_port	Integer	监听器的监听端口。取值范围：[1, 65535]。
loadbalancers	Array of Loadbalancers objects	监听器关联的负载均衡器 ID。详细参见表8。
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
insert_headers	InsertHeaders object	HTTP扩展头部，内部字段全量同步，不选则为默认值。可以将从负载均衡器到后端云服务器的路径中需要被后端云服务器用到的信息写入HTTP中，随报文传递到后端云服务器上。例如可通过X-Forwarded-ELB-IP开关，将负载均衡器的弹性公网IP传到后端云服务器。详细参见表9。
tls_ciphers_policy	String	监听器使用的安全策略，仅对TERMINATED_HTTPS协议类型的监听器有效，且默认值为tls-1-0。取值包括：tls-1-0-inherit，tls-1-0, tls-1-1, tls-1-2, tls-1-2-strict多种安全策略。各安全策略使用的加密套件列表。详细参见表10。
protection_status	String	String 当前资源保护状态, 取值： nonProtection: 不保护，默认值为nonProtection consoleProtection: 控制台修改保护
protection_reason	String	String 资源保护的原因。仅当protection_status为consoleProtection时有效。

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

表7 insert_headers字段说明
参数	是否必选	参数类型	描述
X-Forwarded-ELB-IP	否	Boolean	负载均衡器弹性公网IP透传开关。打开时可以将负载均衡器的弹性公网IP从报文的HTTP头中带到后端云服务器。取值范围：true/false。true：开启。false：关闭。默认：关闭。
X-Forwarded-Host	否	Boolean	负载均衡器X-Forwarded-Host重写开关。打开时可以将客户请求头的X-Forwarded-Host设置为请求头的Host带到后端云服务器取值范围：true/false。true：开启。false：关闭。默认：开启。

表8 tls_ciphers_policy取值说明
安全策略	支持的TLS版本类型	使用的加密套件列表
tls-1-0-inherit	TLS 1.2 TLS 1.1 TLS 1.0	ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:AES128-SHA256:AES256-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:DHE-RSA-AES128-SHA:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:AES128-SHA:AES256-SHA:DHE-DSS-AES128-SHA:CAMELLIA128-SHA:EDH-RSA-DES-CBC3-SHA:DES-CBC3-SHA:ECDHE-RSA-RC4-SHA:RC4-SHA:DHE-RSA-AES256-SHA:DHE-DSS-AES256-SHA:DHE-RSA-CAMELLIA256-SHA:DHE-DSS-CAMELLIA256-SHA:CAMELLIA256-SHA:EDH-DSS-DES-CBC3-SHA:DHE-RSA-CAMELLIA128-SHA:DHE-DSS-CAMELLIA128-SHA
tls-1-0	TLS 1.2 TLS 1.1 TLS 1.0	ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:AES128-SHA256:AES256-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES128-SHA:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:AES128-SHA:AES256-SHA
tls-1-1	TLS 1.2 TLS 1.1
tls-1-2	TLS 1.2
tls-1-2-strict	TLS 1.2	ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256:AES128-SHA256:AES256-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384

请求示例

请求样例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",
            "project_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",
            "insert_headers":{
                "X-Forwarded-ELB-IP":true,
                "X-Forwarded-Host":true
            },
            "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",
            "insert_headers":{
                "X-Forwarded-ELB-IP":true,
                "X-Forwarded-Host":true
            },
            "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",
            "project_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,
            "insert_headers":{
                "X-Forwarded-ELB-IP":true,
                "X-Forwarded-Host":true
            },
 
            "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

直接提交取消