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 del balanceador de carga dedicado/ Oyente/ Consulta de detalles de un listener

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

Ver PDF

Consulta de detalles de un listener

Función

Esta API se utiliza para ver los detalles de un listener.

URI

GET /v3/{project_id}/elb/listeners/{listener_id}

**Tabla 1** Parámetros de path
Parámetro	Obligatorio	Tipo	Descripción
project_id	Sí	String	Especifica el ID del proyecto.
listener_id	Sí	String	Especifica el ID del listener.

Parámetros de solicitud

**Tabla 2** Parámetros de encabezado de solicitud
Parámetro	Obligatorio	Tipo	Descripción
X-Auth-Token	Sí	String	Especifica el token utilizado para la autenticación IAM.

Parámetros de respuesta

Código de estado: 200

**Tabla 3** Parámetros de body de respuesta
Parámetro	Tipo	Descripción
request_id	String	Especifica el ID de la solicitud. El valor se genera automáticamente.
listener	Listener object	Especifica el listener.

**Tabla 4** Listener
Parámetro	Tipo	Descripción
admin_state_up	Boolean	Especifica el estado administrativo del listener. El valor solo puede ser true. Este parámetro no es compatible. Por favor, no lo use.
client_ca_tls_container_ref	String	Especifica el ID del certificado de CA utilizado por el listener. Este parámetro sólo está disponible cuando type se establece en client.
connection_limit	Integer	Especifica el número máximo de conexiones que el equilibrador de carga puede establecer con los servidores backend. El valor -1 indica que el número de conexiones no está limitado. Este parámetro no es compatible. Por favor, no lo use.
created_at	String	Especifica la hora en que se creó el agente de escucha, con el formato aaaa-MM-dd'T''HH:mm:ss''Z'', por ejemplo, 2021-07-30T12:03:44Z.
default_pool_id	String	Especifica el ID del grupo de servidores backend predeterminado. Si no hay ninguna política de reenvío coincidente, las solicitudes se reenvían al servidor backend predeterminado.
default_tls_container_ref	String	Especifica el ID del certificado de servidor utilizado por el listener.
description	String	Proporciona información adicional sobre el listener.
http2_enable	Boolean	Especifica si usar HTTP/2 si desea que los clientes usen HTTP/2 para comunicarse con el equilibrador de carga. Sin embargo, las conexiones entre el balanceador de carga y los servidores backend siguen usando HTTP/1.x de forma predeterminada. Este parámetro solo está disponible para listeners HTTPS. Para los listeners QUIC, no se puede establecer y la respuesta se fija en true. Si configura este parámetro para listeners con otros protocolos, no tendrá efecto.El protocolo QUIC no se admite en la región eu-nl.
id	String	Especifica el ID del listener.
insert_headers	ListenerInsertHeaders object	Especifica los campos de encabezado HTTP que pueden transmitir la información requerida a los servidores backend. Por ejemplo, el campo de cabecera X-Forwarded-ELB-IP puede transmitir el EIP del equilibrador de carga a servidores backend.
loadbalancers	Array of LoadBalancerRef objects	Especifica el ID del equilibrador de carga al que se agrega el listener. Se puede añadir un listener a un solo equilibrador de carga.
name	String	Especifica el nombre del listener.
project_id	String	Especifica el ID del proyecto en el que se utiliza el listener.
protocol	String	Especifica el protocolo utilizado por el listener. El valor puede ser TCP, HTTP, UDP, HTTPS, TERMINATED_HTTPS, o QUIC. Nota: El protocolo utilizado por los listeners HTTPS agregado a un balanceador de carga compartido solo se puede establecer en TERMINATED_HTTPS. Si se pasa HTTPS, el valor se cambiará automáticamente a TERMINATED_HTTPS. El protocolo utilizado por los listeners HTTPS agregado a un balanceador de carga dedicado solo se puede establecer en HTTPS. Si se pasa TERMINATED_HTTPS, el valor se cambiará automáticamente a HTTPS. El protocolo QUIC no se admite en la región eu-nl.
protocol_port	Integer	Especifica el puerto utilizado por el listener para recibir solicitudes de clientes. Mínimo: 1 Máximo: 65535
sni_container_refs	Array of strings	Especifica los ID de los certificados SNI (certificados de servidor con nombres de dominio) utilizados por el listener. Nota: Los nombres de dominio de todos los certificados SNI deben ser únicos. El número total de nombres de dominio de todos los certificados SNI no puede exceder de 30.
sni_match_algo	String	Especifica cómo el nombre de dominio comodín coincide con los certificados SNI utilizados por el listener. longest_suffix indica la coincidencia de sufijo más larga. wildcard indica la coincidencia de comodín. El valor predeterminado es wildcard.
tags	Array of Tag objects	Muestra las etiquetas.
updated_at	String	Especifica la hora en que se actualizó el listener, en el formato yyyy-MM-dd''T''HH:mm:ss''Z'', por ejemplo, 2021-07-30T12:03:44Z.
tls_ciphers_policy	String	Especifica la política de seguridad utilizada por el listener. Valores: tls-1-0-inherit,tls-1-0, tls-1-1, tls-1-2,tls-1-2-strict, tls-1-2-fs, tls-1-0-with-1-3, tls-1-2-fs-with-1-3, hybrid-policy-1-0, y tls-1-0 (predeterminado). Nota: Este parámetro solo tendrá efecto para los listeners HTTPS agregados a un balanceador de carga dedicado. Si se especifican security_policy_id y tls_ciphers_policy, sólo tendrá efecto security_policy_id. La prioridad de la suite de encriptación de alto a bajo es: ecc suite, rsa suite, tls 1.3 suite (que soporta tanto ecc como rsa). El protocolo QUIC no se admite en la región eu-nl.
security_policy_id	String	Especifica el ID de la política de seguridad personalizada. Nota: Este parámetro solo está disponible para listeners HTTPS agregados a un equilibrador de carga dedicado. Si se especifican security_policy_id y tls_ciphers_policy, sólo tendrá efecto security_policy_id. La prioridad de la suite de encriptación de alto a bajo es: ecc suite: ecc suite, rsa suite, tls 1.3 suite (que soporta tanto ecc como rsa).
enable_member_retry	Boolean	Especifica si se habilitan los reintentos de comprobación de estado para los servidores backend. El valor puede ser true (habilitar reintentos de comprobación de estado) o false (habilitar reintentos de comprobación de estado). El valor predeterminado es true. Nota: Si se asocia un equilibrador de carga compartido, este parámetro solo está disponible cuando el protocol se establece en HTTP o TERMINATED_HTTPS. Si se asocia un equilibrador de carga dedicado, este parámetro solo está disponible cuando el protocol se establece en HTTP, HTTPS, o QUIC. El protocolo QUIC no se admite en la región eu-nl.
keepalive_timeout	Integer	Especifica la duración del tiempo de espera inactivo, en segundos. Si no hay solicitudes que lleguen al equilibrador de carga después de que transcurra el tiempo de espera inactivo, el equilibrador de carga desconectará la conexión con el cliente y establecerá una nueva conexión cuando haya una nueva solicitud. Para los listeners TCP, el valor oscila entre 10 y 4000, y el valor predeterminado es 300. Para los listeners HTTP y HTTPS, el valor varía de 1 a 4000, y el valor predeterminado es 60. Para los listeners UDP, este parámetro no tiene efecto.
client_timeout	Integer	Especifica la duración del tiempo de espera de una respuesta de un cliente, en segundos. Hay dos situaciones: Si el cliente no puede enviar una cabecera de solicitud al equilibrador de carga dentro de la duración del tiempo de espera, la solicitud se interrumpirá. Si el intervalo entre dos cuerpos de solicitud consecutivos que llegan al equilibrador de carga es mayor que la duración del tiempo de espera, la conexión se desconectará. El valor varía de 1 a 300, y el valor predeterminado es 60. Este parámetro solo está disponible para listeners HTTP y HTTPS.
member_timeout	Integer	Especifica la duración del tiempo de espera de una respuesta de un servidor backend, en segundos. Si el servidor backend no responde después de que transcurra el tiempo de espera, el equilibrador de carga dejará de esperar y devolverá el tiempo de espera de la puerta de enlace HTTP 504 al cliente. El valor varía de 1 a 300, y el valor predeterminado es 60. Este parámetro solo está disponible para listeners HTTP y HTTPS.
ipgroup	ListenerIpGroup object	Especifica el grupo de direcciones IP asociado al listener.
transparent_client_ip_enable	Boolean	Especifica si se deben pasar las direcciones IP de origen de los clientes a los servidores backend. TCP o UDP listeners de balanceadores de carga compartidos: El valor puede ser true o false, y el valor predeterminado es false si no se pasa este parámetro. HTTP o HTTPS listeners de balanceadores de carga compartidos: El valor solo puede ser true, y el valor predeterminado es true si no se pasa este parámetro. Todos los listeners de balanceadores de carga dedicados: El valor solo puede ser true, y el valor predeterminado es true si este parámetro no se pasa. Nota: Si esta función está habilitada, el balanceador de carga se comunica con los servidores backend utilizando sus direcciones IP reales. Asegúrese de que las reglas del grupo de seguridad y las directivas de control de acceso estén correctamente configuradas. Si esta función está habilitada, un servidor no puede servir como servidor backend y como cliente. Si esta función está habilitada, las especificaciones del servidor backend no se pueden cambiar.
enhance_l7policy_enable	Boolean	Especifica si se habilitará el reenvío avanzado. El valor puede ser true (habilitar el reenvío avanzado) o false (habilitar el reenvío avanzado) y el valor predeterminado es false. Si esta función está habilitada, action se puede establecer en REDIRECT_TO_URL (las solicitudes se redirigirán a otra URL) o Fixed_RESPONSE (un cuerpo de respuesta fijo se devolverá a los clientes). En una política de reenvío se pueden especificar los parámetros priority, redirect_url_config, y fixed_response_config. El parámetro type se puede establecer en METHOD, HEADER, QUERY_STRING, o SOURCE_IP para una regla de reenvío. Si type se establece en HOST_NAME para una regla de reenvío, el parámetro de value de la regla de reenvío admite asteriscos comodín (). El parámetro de conditions* se puede especificar para las reglas de reenvío. Este parámetro no está disponible en la región eu-nl. Por favor, no lo use. Predeterminado: false
quic_config	ListenerQuicConfig object	Especifica la configuración de QUIC para el listener actual. Este parámetro solo es válido cuando el protocol se establece en HTTPS. Para un listener TCP/UDP/HTTP/QUIC, si este parámetro no se deja en blanco, se reportará un error. NOTA: El cliente envía una solicitud HTTP normal que contiene información que indica que se admite el protocolo QUIC. Si la actualización de QUIC está habilitada para los listeners, la información de puerto y versión de QUIC se añadirá al encabezado de respuesta. Cuando el cliente envía solicitudes HTTPS y QUIC al servidor, si la solicitud QUIC se envía con éxito, el protocolo QUIC se utilizará para comunicaciones posteriores. El protocolo QUIC no se admite en la región eu-nl.

**Tabla 5** ListenerInsertHeaders
Parámetro	Tipo	Descripción
X-Forwarded-ELB-IP	Boolean	Especifica si se debe transmitir de forma transparente el EIP del equilibrador de carga a los servidores backend. Si X-Forwarded-ELB-IP se establece en true, el balanceador de carga EIP se almacenará en el encabezado HTTP y se pasará a los servidores backend. Predeterminado: false
X-Forwarded-Port	Boolean	Especifica si se debe transmitir de forma transparente el puerto de escucha del equilibrador de carga a los servidores backend. Si X-Forwarded-Port se establece en true, el puerto de escucha del balanceador de carga se almacenará en el encabezado HTTP y se pasará a los servidores backend. Predeterminado: false
X-Forwarded-For-Port	Boolean	Especifica si se debe transmitir de forma transparente el puerto de origen del cliente a los servidores backend. Si X-Forwarded-For-Port se establece en true, el puerto de origen del cliente se almacenará en el encabezado HTTP y se pasará a los servidores backend. Predeterminado: false
X-Forwarded-Host	Boolean	Especifica si se debe volver a escribir el encabezado X-Forwarded-Host. Si X-Forwarded-Host se establece en true, X-Forwarded-Host en el encabezado de solicitud de los clientes se puede establecer en Host en el encabezado de solicitud enviado desde el equilibrador de carga a los servidores backend. Predeterminado: true

**Tabla 6** LoadBalancerRef
Parámetro	Tipo	Descripción
id	String	Especifica el ID del equilibrador de carga.

**Tabla 7** Tag
Parámetro	Tipo	Descripción
key	String	Especifica la clave de etiqueta. Mínimo: 1 Máximo: 36
value	String	Especifica el valor de etiqueta. Mínimo: 0 Máximo: 43

**Tabla 8** ListenerIpGroup
Parámetro	Tipo	Descripción
ipgroup_id	String	Especifica el ID del grupo de direcciones IP asociado al listener. Este parámetro es obligatorio cuando se crea el grupo de direcciones IP y es opcional cuando se actualiza el grupo de direcciones IP. El grupo de direcciones IP especificado debe existir y el valor no puede ser null.
enable_ipgroup	Boolean	Especifica si se debe habilitar el control de acceso. true: El control de acceso está habilitado. false: el control de acceso está deshabilitado. Un listener con control de acceso habilitado se puede eliminar directamente.
type	String	Especifica cómo se controla el acceso al listener. white: se configura una lista blanca. Solo las direcciones IP de la lista blanca pueden acceder al listener. black: se configura una lista negra. Las direcciones IP de la lista negra no pueden acceder al listener.

**Tabla 9** ListenerQuicConfig
Parámetro	Tipo	Descripción
quic_listener_id	String	Especifica el ID del agente de escucha QUIC. Este parámetro es obligatorio para la creación y es opcional para la actualización. El quic_listener_id especificado debe existir. El protocolo de escucha debe ser QUIC y no se puede establecer en null, de lo contrario, entrará en conflicto con enable_quic_upgrade. El protocolo QUIC no se admite en la región eu-nl.
enable_quic_upgrade	Boolean	Especifica si se debe habilitar la actualización de QUIC. True: la actualización de QUIC está habilitada. False: la actualización de QUIC está deshabilitada. Los listeners HTTPS se pueden actualizar a listeners QUIC. El protocolo QUIC no se admite en la región eu-nl.

Solicitudes de ejemplo

Consulta de detalles de un listener

GET https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/listeners/0b11747a-b139-492f-9692-2df0b1c87193

Ejemplo de respuestas

Código de estado: 200

Solicitud exitosa.

{
  "listener" : {
    "id" : "0b11747a-b139-492f-9692-2df0b1c87193",
    "name" : "My listener",
    "protocol_port" : 80,
    "protocol" : "TCP",
    "ipgroup" : null,
    "description" : "My listener update.",
    "default_tls_container_ref" : null,
    "admin_state_up" : true,
    "loadbalancers" : [ {
      "id" : "098b2f68-af1c-41a9-8efd-69958722af62"
    } ],
    "member_timeout" : null,
    "client_timeout" : null,
    "keepalive_timeout" : 300,
    "client_ca_tls_container_ref" : null,
    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
    "sni_container_refs" : [ ],
    "connection_limit" : -1,
    "default_pool_id" : null,
    "tls_ciphers_policy" : "tls-1-0",
    "tags" : [ ],
    "created_at" : "2019-04-02T00:12:32Z",
    "updated_at" : "2019-04-02T17:43:46Z",
    "http2_enable" : true,
    "insert_headers" : {
      "X-Forwarded-ELB-IP" : true
    },
    "transparent_client_ip_enable" : false
  },
  "request_id" : "1394eb39-e4c8-4177-b96d-aaff569f1833"
}