查询监听器
功能介绍
查询监听器列表。支持过滤查询和分页查询。如未特殊说明,匹配规则为精确匹配。
可以通过监听器ID、协议类型、监听端口号、关联的后端云服务器的IP等查询监听器。
接口约束
分页查询使用的参数为marker、limit、page_reverse。marker和page_reverse只有和limit一起使用时才会生效,单独使用无效。
URI
GET /v2.0/lbaas/listeners
请求消息
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
marker |
否 |
String |
分页查询的起始的资源ID,表示上一页最后一条查询记录的监听器的ID。 必须与limit一起使用。 |
limit |
否 |
Integer |
分页查询每页的监听器个数。 |
page_reverse |
否 |
Boolean |
分页的顺序,true表示从后往前分页,false表示从前往后分页,默认为false。 必须与limit一起使用。 |
id |
否 |
String |
监听器 ID。 |
tenant_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。 支持的最大字符长度:128 |
client_ca_tls_container_ref |
否 |
String |
监听器使用的CA证书ID。 支持的最大字符长度:128 |
protocol |
否 |
String |
监听器的监听协议。 取值范围:TCP、HTTP、UDP、TERMINATED_HTTPS。 |
protocol_port |
否 |
Integer |
监听器的监听端口。 |
tls_container_id |
否 |
String |
查询证书所关联的监听器。 |
sni_container_refs |
否 |
String |
查询SNI证书关联的监听器。 |
安全策略 |
支持的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 |
响应消息
参数 |
参数类型 |
描述 |
---|---|---|
listeners |
Array |
监听器对象列表。详见表4。 |
listeners_links |
Array |
监听器的分页查询中上下页的链接信息。仅当分页查询时响应体中有该字段。详见表 listeners_links字段说明。 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
监听器绑定的负载均衡器ID的列表。 |
connection_limit |
Integer |
监听器的最大连接数。 取值范围:[-1, 2147483647]。
说明:
该字段为预留字段,暂未启用。默认为-1,无连接数限制。 |
admin_state_up |
Boolean |
监听器的管理状态。 该字段为预留字段,暂未启用。取值范围:true/false。
|
http2_enable |
Boolean |
HTTP2功能的开启状态。 取值范围:true/false。true:开启。false:关闭。
说明:
仅针对监听器的协议为TERMINATED_HTTPS有意义。 |
keepalive_timeout |
Integer |
空闲超时时间。 仅适用于监听器的协议为TCP、HTTP、TERMINATED_HTTPS。 取值范围:
|
client_timeout |
Integer |
请求超时时间。 取值范围: [1, 300]。单位:秒。默认值:60。 该字段仅在protocol为HTTP或HTTPS下有效;其他情况下,请求体中不应有该字段,否则报错。protocol为HTTP或HTTPS的情况下,若请求体中,无该字段或该字段值为null时,则该字段被赋为默认值。 |
member_timeout |
Integer |
响应超时时间。 取值范围: [1, 300]。单位:秒。默认值:60。 该字段仅在protocol为HTTP或HTTPS下有效;其他情况下,请求体中不应有该字段,否则报错。protocol为HTTP或HTTPS的情况下,若请求体中,无该字段或该字段值为null时,则该字段被赋为默认值。 |
default_pool_id |
String |
监听器的默认后端云服务器组ID。
说明:
当请求没有匹配的转发策略时,转发到默认后端云服务器上处理。当该字段为null时,表示监听器无默认的后端云服务器组。 |
default_tls_container_ref |
String |
监听器使用的服务器证书ID。 当protocol参数为TERMINATED_HTTPS时,为必选字段。 支持的最大字符长度:128 |
client_ca_tls_container_ref |
String |
监听器使用的CA证书ID。 支持的最大字符长度:128 |
sni_container_refs |
Array |
监听器使用的SNI证书(带域名的服务器证书)ID的列表。 |
tags |
Array |
监听器的标签。 |
created_at |
String |
监听器的创建时间。YYYY-MM-DDTHH:MM:SS 支持的最大字符长度:19 |
updated_at |
String |
监听器的更新时间。YYYY-MM-DDTHH:MM:SS 支持的最大字符长度:19 |
listeners_links |
Array |
监听器的分页查询中上下页的链接信息。仅当分页查询时响应体中有该字段。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
关联的负载均衡器id |
安全策略 |
支持的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.0/lbaas/listeners?limit=2
- 请求样例2 过滤查询协议类型为UDP的监听器
GET https://{Endpoint}/v2.0/lbaas/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" , } ], "listeners_links": [ { "href": "https://{Endpoint}/v2.0/lbaas/listeners?limit=2&marker=042cc6a5-e385-4e39-83de-4dde1f801ccb", "rel": "next" }, { "href": "https://{Endpoint}/v2.0/lbaas/listeners?limit=2&marker=025fcaa9-0159-4a0d-8583-d97fa77d9972&page_reverse=True", "rel": "previous" } ] }
- 响应样例2
{ "listeners": [ { "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" } ] }
返回码
请参见状态码。