Consulta de oyentes
Función
Esta API se utiliza para consultar los oyentes y mostrarlos en una lista. Se admite la consulta de filtro y la consulta de paginación. A menos que se especifique lo contrario, se aplica una coincidencia exacta.
Puede consultar oyentes usando información como ID de oyente, protocolo utilizado por el oyente, puerto utilizado por el oyente, o dirección IP privada del servidor backend.
URI
GET /v2/{project_id}/elb/listeners
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
Especifica el ID del proyecto. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
marker |
No |
String |
Especifica el ID del oyente desde el que se inicia la consulta de paginación, es decir, el ID del último oyente de la página anterior. Este parámetro debe usarse junto con limit. |
limit |
No |
Integer |
Especifica el número de oyentes en cada página. Si este parámetro no está definido, todas las oyentes se consultan de forma predeterminada. |
page_reverse |
No |
Boolean |
Especifica la dirección de la página. El valor puede ser true o false, y el valor predeterminado es false. La última página de la lista solicitada con page_reverse establecido en false no contendrá el enlace "next", y la última página de la lista solicitada con page_reverse establecido en true no contendrá el enlace "anterior". Este parámetro debe usarse junto con limit. |
id |
No |
String |
Especifica el ID de oyente. |
name |
No |
String |
Especifica el nombre de oyente. El valor contiene un máximo de 255 caracteres. |
description |
No |
String |
Proporciona información complementaria sobre el oyente. El valor contiene un máximo de 255 caracteres. |
loadbalancer_id |
No |
String |
Especifica el ID del balanceador de carga asociado. |
connection_limit |
No |
Integer |
Especifica el número máximo de conexiones. |
admin_state_up |
No |
Boolean |
Especifica el estado administrativo del oyente. Este parámetro está reservado y el valor predeterminado es true. |
default_pool_id |
No |
String |
Especifica el ID del grupo de servidores backend asociado. Si una solicitud no coincide con la política de reenvío, la solicitud se reenvía al grupo de servidores backend predeterminado para su procesamiento. |
http2_enable |
No |
Boolean |
Especifica si se debe usar HTTP/2. El valor puede ser true o false.
|
default_tls_container_ref |
No |
String |
Especifica el ID del certificado de servidor utilizado por el oyente. |
client_ca_tls_container_ref |
No |
String |
Especifica el ID del certificado de CA utilizado por el oyente. |
protocol |
No |
String |
Especifica el protocolo utilizado por el oyente. El valor puede ser TCP, HTTP, UDP o TERMINATED_HTTPS. |
protocol_port |
No |
Integer |
Especifica el puerto utilizado por el oyente. |
enterprise_project_id |
No |
String |
Especifica el ID del proyecto de empresa. Los proyectos empresariales se utilizan para la autenticación detallada.
|
tls_ciphers_policy |
No |
String |
Especifica la política de seguridad utilizada por el oyente. Este parámetro solo tiene efecto cuando el protocolo utilizado por el oyente se establece en TERMINATED_HTTPS. El valor puede ser tls-1-0-inherit, tls-1-0, tls-1-1, tls-1-2, o tls-1-2-strict, y el valor predeterminado es tls-1-0. Para obtener más información sobre conjuntos de cifrado para cada política de seguridad, consulte Tabla 3. |
Política de seguridad |
Versión de TLS |
Suite de cifrado |
---|---|---|
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 |
Solicitud
No hay
Respuesta
Parámetro |
Tipo |
Descripción |
---|---|---|
listeners |
Array of Listeners objects |
Enumera los oyentes. Para más detalles, consulte Tabla 5. |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
Especifica el ID de oyente. |
tenant_id |
String |
Especifica el ID del proyecto donde se utiliza el oyente. El valor contiene un máximo de 255 caracteres. |
project_id |
String |
Especifica el ID del proyecto al que pertenece el oyente. Este parámetro tiene el mismo significado que tenant_id. |
name |
String |
Especifica el nombre de oyente. El valor contiene un máximo de 255 caracteres. |
description |
String |
Proporciona información complementaria sobre el oyente. El valor contiene un máximo de 255 caracteres. |
protocol |
String |
Especifica el protocolo utilizado por el oyente. El valor puede ser TCP, HTTP, UDP o TERMINATED_HTTPS. |
protocol_port |
Integer |
Especifica el puerto utilizado por el oyente. El número de puerto se encuentra dentro del rango de 1 a 65535. |
loadbalancers |
Array of Loadbalancers objects |
Especifica el ID del balanceador de carga asociado. Para más detalles, consulte Tabla 7. |
connection_limit |
Integer |
Especifica el número máximo de conexiones. El valor oscila entre -1 y 2147483647. El valor predeterminado es -1, lo que indica que no hay restricción en el número máximo de conexiones. Este parámetro está reservado. |
admin_state_up |
Boolean |
Especifica el estado administrativo del oyente. Este parámetro está reservado. El valor puede ser true o false.
|
http2_enable |
Boolean |
Especifica si se debe usar HTTP/2. El valor puede ser true o false.
Este parámetro solo tiene efecto cuando el protocolo utilizado por el oyente se establece en TERMINATED_HTTPS. |
default_pool_id |
String |
Especifica el ID del grupo de servidores backend asociado. Si una solicitud no coincide con la política de reenvío, la solicitud se reenvía al grupo de servidores backend predeterminado para su procesamiento. Si el valor es null, el oyente no tiene un grupo de servidores backend predeterminado. |
default_tls_container_ref |
String |
Especifica el ID del certificado de servidor utilizado por el oyente. Para más detalles, consulte Certificado. Este parámetro es obligatorio cuando protocol se establece en TERMINATED_HTTPS. El valor contiene un máximo de 128 caracteres. |
client_ca_tls_container_ref |
String |
Especifica el ID del certificado de CA utilizado por el oyente. El valor contiene un máximo de 128 caracteres. Para más detalles, consulte Certificado. |
sni_container_refs |
Array |
Enumera los ID de los certificados SNI (certificados de servidor con nombres de dominio) utilizados por el oyente. Si el valor del parámetro es una lista vacía, la función SNI está deshabilitada. |
tags |
Array |
Etiqueta al oyente. |
created_at |
String |
Especifica la hora a la que se creó el oyente.YYYY-MM-DDTHH:MM:SS |
updated_at |
String |
Especifica la hora a la que se actualizó el oyente.YYYY-MM-DDTHH:MM:SS |
tls_ciphers_policy |
String |
Especifica la política de seguridad utilizada por el oyente. Este parámetro solo tiene efecto cuando el protocolo utilizado por el oyente se establece en TERMINATED_HTTPS. El valor puede ser tls-1-0-inherit, tls-1-0, tls-1-1, tls-1-2, o tls-1-2-strict, y el valor predeterminado es tls-1-0. Enumera los conjuntos de cifrado utilizados por cada política de seguridad. Para más detalles, consulte Tabla 8. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
id |
Sí |
String |
Especifica el ID del balanceador de carga asociado. |
Política de seguridad |
Versión de TLS |
Suite de cifrado |
---|---|---|
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 |
Ejemplo de la solicitud
- Ejemplo de solicitud 1: Consulta de todos los oyentes
GET https://{Endpoint}/v2/601240b9c5c94059b63d484c92cfe308/elb/listeners
- Ejemplo de solicitud 2: Consulta de oyentes UDP
GET https://{Endpoint}/v2/601240b9c5c94059b63d484c92cfe308/elb/listeners?protocol=UDP
Ejemplo de la respuesta
- Ejemplo de respuesta 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", , "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" } ] }
- Ejemplo de respuesta 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, "admin_state_up": true, "default_pool_id": "2f6895be-019b-4c82-9b53-c4a2ac009e20", "id": "5c63d176-444f-4c75-9cfe-bcb8a05a845c", "tags": [], "name": "listener-tvp8" } ] }
Código de estado
Para más detalles, consulte Códigos de estado.