Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.

Centro de ayuda/ Elastic Load Balance/ Referencia de la API/ API históricas/ API de balanceador de carga mejorado compartido (OpenStack)/ Oyente/ Consulta de oyentes

Actualización más reciente 2022-11-17 GMT+08:00

Ver PDF

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.

Restricciones

Los parámetros marker, limit y page_reverse se utilizan para la consulta de paginación. Los parámetros marker y page_reverse solo tienen efecto cuando se usan junto con el parámetro limit.

URI

GET /v2.0/lbaas/listeners

Solicitud

**Tabla 1** Descripción del parámetro
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.
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.
tenant_id	No	String	Especifica el ID del proyecto donde se utiliza el oyente.
project_id	No	String	Especifica el ID del proyecto al que pertenece el oyente. Este parámetro tiene el mismo significado que tenant_id.
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.
http2_enable	No	Boolean	Especifica si se debe usar HTTP/2. El valor puede ser true o false. true: se utiliza HTTP/2. false: no se utiliza HTTP/2.
default_tls_container_ref	No	String	Especifica el ID del certificado de servidor utilizado por el oyente. El valor contiene un máximo de 128 caracteres.
client_ca_tls_container_ref	No	String	Especifica el ID del certificado de CA utilizado por el oyente. El valor contiene un máximo de 128 caracteres.
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.
tls_ciphers_policy	No	String	Especifica la política de seguridad utilizada por el oyente. Este parámetro es válido solo cuando el protocolo utilizado por el oyente se establece en TERMINATED_HTTPS. El valor puede ser tls-1-0, tls-1-1, tls-1-2, o tls-1-2-strict. Para obtener más información sobre conjuntos de cifrado para cada política de seguridad, consulte Tabla 2.
tls_container_id	No	String	Consulta al oyente asociado al certificado.
sni_container_refs	No	String	Consulta al oyente asociado al certificado SNI.

**Tabla 2** Descripción de parámetro **tls_ciphers_policy**
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

Respuesta

**Tabla 3** Descripción del parámetro
Parámetro	Tipo	Descripción
listeners	Array	Enumera los oyentes. Para más detalles, consulte Tabla 4.
listeners_links	Array	Proporciona enlaces a la página anterior o siguiente durante la consulta de paginación, respectivamente. Este parámetro solo existe en el cuerpo de respuesta de la consulta de paginación. Para más detalles, consulte Tabla 7.

**Tabla 4** Descripción del parámetro **listeners**
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	Especifica el ID del balanceador de carga asociado.
connection_limit	Integer	Especifica el número máximo de conexiones. El valor oscila entre -1 y 2147483647. NOTA: Este parámetro está reservado. El valor predeterminado es -1, lo que indica que no hay restricción en el número máximo de conexiones.
admin_state_up	Boolean	Especifica el estado administrativo del oyente. Este parámetro está reservado. El valor puede ser true o false. true: habilitar false: deshabilitar
http2_enable	Boolean	Especifica si se debe usar HTTP/2. El valor puede ser true o false. true: se usará HTTP/2. false: no se usará HTTP/2. NOTA: Este parámetro es válido solo cuando el protocolo utilizado por el oyente se establece en TERMINATED_HTTPS.
keepalive_timeout	Integer	Especifica la duración del tiempo de espera inactivo en la unidad de segundo. Este parámetro solo se aplica a oyentes TCP, HTTP o HTTPS. El valor puede ser uno de los siguientes: TCP oyentes: El valor oscila entre 10 y 4000, y el valor predeterminado es 300. HTTP o HTTPS oyentes: El valor oscila entre 0 y 4000, y el valor predeterminado es 60.
client_timeout	Integer	Especifica la duración del tiempo de espera de la solicitud en la unidad de segundo. El valor varía de 1 a 300. El valor predeterminado es 60. Este parámetro solo es válido cuando protocol se establece en HTTP o HTTPS. En otros casos, el cuerpo de la solicitud no contiene este parámetro. De lo contrario, se notifica un error. Cuando protocol se establece en HTTP o HTTPS, si el cuerpo de la solicitud no contiene este parámetro o si el valor de este parámetro es nulo, se utiliza el valor predeterminado.
member_timeout	Integer	Especifica la duración del tiempo de espera de respuesta en la unidad de segundo. El valor varía de 1 a 300. El valor predeterminado es 60. Este parámetro solo es válido cuando protocol se establece en HTTP o HTTPS. En otros casos, el cuerpo de la solicitud no contiene este parámetro. De lo contrario, se notifica un error. Cuando protocol se establece en HTTP o HTTPS, si el cuerpo de la solicitud no contiene este parámetro o si el valor de este parámetro es nulo, se utiliza el valor predeterminado.
default_pool_id	String	Especifica el ID del grupo de servidores backend asociado. NOTA: 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. 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.
sni_container_refs	Array	Enumera los ID de los certificados SNI (certificados de servidor con nombres de dominio) utilizados por el oyente.
tags	Array	Etiquetas al oyente.
created_at	String	Especifica la hora a la que se creó el oyente. La hora UTC está en formato YYYY-MM-DDTHH:MM:SS. El valor contiene un máximo de 19 caracteres.
updated_at	String	Especifica la hora a la que se actualizó el oyente. La hora UTC está en formato YYYY-MM-DDTHH:MM:SS. El valor contiene un máximo de 19 caracteres.
listeners_links	Array	Proporciona enlaces a la página anterior o siguiente durante la consulta de paginación, respectivamente. Este parámetro solo existe en el cuerpo de respuesta de la consulta de paginación.
tls_ciphers_policy	String	Especifica la política de seguridad utilizada por el oyente. Este parámetro es válido solo 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 6.

**Tabla 5** Descripción de parámetro **loadbalancers**
Parámetro	Tipo	Descripción
id	String	Especifica el ID del balanceador de carga asociado.

**Tabla 6** Descripción de parámetro **tls_ciphers_policy**
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

**Tabla 7** Descripción de parámetro **listeners_links**
Parámetro	Tipo	Descripción
href	String	Proporciona enlaces a la página anterior o siguiente durante la consulta de paginación, respectivamente.
rel	String	Especifica la solicitud de la página anterior o siguiente. El valor puede ser next o previous. El valor next indica el href que contiene la dirección URL de la página siguiente, y previous indica el href que contiene la dirección URL de la página anterior.

Ejemplo de la solicitud

Ejemplo de solicitud 1: Consulta de todos los oyentes
```
GET https://{Endpoint}/v2.0/lbaas/listeners?limit=2
```

Ejemplo de solicitud 2: Consulta de oyentes UDP

GET https://{Endpoint}/v2.0/lbaas/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",
            "project_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"
        }
    ]
}

Ejemplo de respuesta 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",
            "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"
        }
    ]
}