Consulta de oyentes
Función
Esta API se utiliza para consultar oyentes.
Restricciones
Esta API tiene las siguientes 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 /v3/{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 |
---|---|---|---|
limit |
No |
Integer |
Especifica el número de registros de cada página. Mínimo: 0 Máximo: 2000 Predeterminado: 2000 |
marker |
No |
String |
Especifica el identificador del último registro de la página anterior. Nota:
|
page_reverse |
No |
Boolean |
Especifica si se va a utilizar la consulta inversa. Valores:
Nota:
|
protocol_port |
No |
Array |
Especifica el puerto utilizado por el oyente. Se pueden consultar varios puertos en el formato de protocol_port=xxx&protocol_port=xxx. |
protocol |
No |
Array |
Especifica el protocolo utilizado por el oyente. El valor puede ser TCP, HTTP, UDP, HTTPS o TERMINATED_HTTPS. Nota: TERMINATED_HTTPS solo está disponible para los oyentes de balanceadores de carga compartidos. Se pueden consultar múltiples protocolos en el formato de protocol=xxx&protocol=xxx. El protocolo QUIC no se admite en la región eu-nl. |
description |
No |
Array |
Proporciona información complementaria sobre el oyente. Se pueden consultar varias descripciones en el formato de description=xxx&description=xxx. |
default_tls_container_ref |
No |
Array |
Especifica el ID del certificado de servidor utilizado por el oyente. Se pueden consultar varios ID con el formato default_tls_container_ref=xxx&default_tls_container_ref=xxx. |
client_ca_tls_container_ref |
No |
Array |
Especifica el ID del certificado de CA utilizado por el oyente. Se pueden consultar varios ID con el formato client_ca_tls_container_ref=xxx&client_ca_tls_container_ref=xxx. |
admin_state_up |
No |
Boolean |
Especifica el estado administrativo del oyente. El valor solo puede ser true. Este parámetro no es compatible. Por favor, no lo use. |
connection_limit |
No |
Array |
Especifica el número máximo de conexiones que el balanceador de carga puede establecer con los servidores backend. El valor -1 indica que el número de conexiones no está limitado. Multiple values can be queried in the format of connection_limit=xxx&connection_limit=xxx. Este parámetro no es compatible. Por favor, no lo use. |
default_pool_id |
No |
Array |
Especifica el ID del grupo de servidores backend predeterminado. Si no hay ninguna política de reenvío coincidente, las solicitudes se encaminarán al servidor de backend predeterminado. Se pueden consultar varios ID con el formato default_pool_id=xxx&default_pool_id=xxx. |
id |
No |
Array |
Especifica el ID de oyente. Se pueden consultar múltiples ID en el formato id=xxx&id=xxx. |
name |
No |
Array |
Especifica el nombre del oyente agregado al balanceador de carga. Se pueden consultar varios nombres con el formato name=xxx&name=xxx. |
http2_enable |
No |
Boolean |
Especifica si usar HTTP/2 si desea que los clientes usen HTTP/2 para comunicarse con oyente. 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 oyentes HTTPS. Para QUIC oyentes, no se puede establecer y la respuesta se fija en true. Si configura este parámetro para oyentes con otros protocolos, no tendrá efecto. El protocolo QUIC no se admite en la región eu-nl. |
loadbalancer_id |
No |
Array |
Especifica el ID del balanceador de carga al que se agrega el oyente. Se pueden consultar varios ID en el formato loadbalancer_id=xxx&loadbalancer_id=xxx. |
tls_ciphers_policy |
No |
Array |
Especifica la política de seguridad utilizada por el oyente. Se pueden consultar varias políticas de seguridad en el formato tls_ciphers_policy=xxx&tls_ciphers_policy=xxx. |
member_address |
No |
Array |
Especifica la dirección IP privada enlazada al servidor backend. Este parámetro solo se utiliza como condición de consulta y no se incluye en la respuesta. Se pueden consultar varias direcciones IP en el formato member_address=xxx&member_address=xxx. |
member_device_id |
No |
Array |
Especifica el ID del servidor en la nube que sirve como servidor backend. Este parámetro solo se utiliza como condición de consulta y no se incluye en la respuesta. Se pueden consultar varios identificadores en el formato member_device_id=xxx&member_device_id=xxx. |
enterprise_project_id |
No |
Array |
Especifica el ID del proyecto de empresa.
Se pueden consultar varios identificadores en el formato enterprise_project_id=xxx&enterprise_project_id=xxx. Este parámetro no es compatible. Por favor, no lo use. |
enable_member_retry |
No |
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). |
member_timeout |
No |
Array |
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 balanceador 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. Se pueden consultar varias duraciones en el formato member_timeout=xxx&member_timeout=xxx. |
client_timeout |
No |
Array |
Especifica la duración del tiempo de espera de una respuesta de un cliente, en segundos. Hay dos situaciones:
El valor varía de 1 a 300. Se pueden consultar varias duraciones en el formato client_timeout=xxx&client_timeout=xxx. |
keepalive_timeout |
No |
Array |
Especifica la duración del tiempo de espera inactivo, en segundos. Si no hay solicitudes que lleguen al balanceador de carga después de que transcurra el tiempo de espera inactivo, el balanceador de carga desconectará la conexión con el cliente y establecerá una nueva conexión cuando haya una nueva solicitud.
Se pueden consultar varias duraciones en el formato keepalive_timeout=xxx&keepalive_timeout=xxx. |
transparent_client_ip_enable |
No |
Boolean |
Especifica si se deben pasar las direcciones IP de origen de los clientes a los servidores backend. Este parámetro solo está disponible para oyentes TCP o UDP de balanceadores de carga compartidos.
|
enhance_l7policy_enable |
No |
Boolean |
Especifica si se habilitará el reenvío avanzado. Si habilita esta función, puede configurar políticas y reglas de reenvío más flexibles.
|
member_instance_id |
No |
Array |
Especifica el ID del servidor backend. Este parámetro solo se utiliza como condición de consulta y no se incluye en la respuesta. Se pueden consultar varios ID con el formato member_instance_id=xxx&member_instance_id=xxx. |
Parámetros 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
Parámetro |
Tipo |
Descripción |
---|---|---|
request_id |
String |
Especifica el ID de la solicitud. El valor se genera automáticamente. |
page_info |
PageInfo object |
Muestra información de paginación sobre oyentes. |
listeners |
Array of Listener objects |
Enumera los oyentes. |
Parámetro |
Tipo |
Descripción |
---|---|---|
previous_marker |
String |
Especifica el ID del primer registro del resultado de la consulta de paginación. Establezca este parámetro para consultar la página anterior. |
next_marker |
String |
Especifica el ID del último registro del resultado de la consulta de paginación. Establezca este parámetro para consultar la página siguiente. |
current_count |
Integer |
Especifica el número de registros. |
Parámetro |
Tipo |
Descripción |
---|---|---|
admin_state_up |
Boolean |
Especifica el estado administrativo del oyente. 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 oyente. 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 balanceador 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 oyente, en el formato yyyy-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 oyente. |
description |
String |
Proporciona información complementaria sobre el oyente. |
http2_enable |
Boolean |
Especifica si usar HTTP/2 si desea que los clientes usen HTTP/2 para comunicarse con el balanceador 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 oyentes HTTPS. Para QUIC oyentes, no se puede establecer y la respuesta se fija en true. Si configura este parámetro para oyentes con otros protocolos, no tendrá efecto.El protocolo QUIC no es compatible con la región eu-nl. |
id |
String |
Especifica el ID de oyente. |
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 balanceador de carga a servidores backend. |
loadbalancers |
Array of LoadBalancerRef objects |
Especifica el ID del balanceador de carga al que se agrega el oyente. Un oyente se puede agregar a un solo balanceador de carga. |
name |
String |
Especifica el nombre de oyente. |
project_id |
String |
Especifica el ID del proyecto donde se utiliza el oyente. |
protocol |
String |
Especifica el protocolo utilizado por el oyente. El valor puede ser TCP, HTTP, UDP, HTTPS, TERMINATED_HTTPS, o QUIC. Nota:
El protocolo QUIC no se admite en la región eu-nl. |
protocol_port |
Integer |
Especifica el puerto utilizado por el oyente 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 oyente. Nota:
|
sni_match_algo |
String |
Especifica cómo el nombre de dominio comodín coincide con los certificados SNI utilizados por el oyente. 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 oyente, 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 oyente. 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:
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:
|
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:
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 balanceador de carga después de que transcurra el tiempo de espera inactivo, el balanceador de carga desconectará la conexión con el cliente y establecerá una nueva conexión cuando haya una nueva solicitud.
|
client_timeout |
Integer |
Especifica la duración del tiempo de espera de una respuesta de un cliente, en segundos. Hay dos situaciones:
El valor varía de 1 a 300, y el valor predeterminado es 60. Este parámetro solo está disponible para oyentes 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 balanceador 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 oyentes HTTP y HTTPS. |
ipgroup |
ListenerIpGroup object |
Especifica el grupo de direcciones IP asociado al oyente. |
transparent_client_ip_enable |
Boolean |
Especifica si se deben pasar las direcciones IP de origen de los clientes a los servidores backend.
Nota:
|
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.
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 QUIC para el oyente actual. Este parámetro solo es válido cuando protocol se establece en HTTPS. Para un oyente 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 oyentes, la información del puerto y la versión de QUIC se agregará 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. |
Parámetro |
Tipo |
Descripción |
---|---|---|
X-Forwarded-ELB-IP |
Boolean |
Especifica si se debe transmitir de forma transparente el EIP del balanceador 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 balanceador 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 balanceador de carga a los servidores backend. Predeterminado: true |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
Especifica el ID del balanceador de carga. |
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 |
Parámetro |
Tipo |
Descripción |
---|---|---|
ipgroup_id |
String |
Especifica el ID del grupo de direcciones IP asociado al oyente. 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.
Un oyente con control de acceso habilitado se puede eliminar directamente. |
type |
String |
Especifica cómo se controla el acceso al oyente.
|
Parámetro |
Tipo |
Descripción |
---|---|---|
quic_listener_id |
String |
Especifica el ID del QUIC oyente. 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 oyente 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. HTTPS oyentes se pueden actualizar a QUIC oyentes. El protocolo QUIC no se admite en la región eu-nl. |
Ejemplo de las solicitudes
Consulta a los oyentes en cada página
GET https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/listeners?limit=2&marker=0r31747a-b139-492f-2749-2df0b1c87193
Ejemplo de las respuestas
Código de estado: 200
Consulta a los oyentes en cada página
{ "listeners" : [ { "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, "quic_config" : null }, { "id" : "0b455839-3ea7-4bac-ad26-35bf22f96ea4", "name" : "listener-test", "protocol_port" : 86, "protocol" : "TERMINATED_HTTPS", "description" : null, "default_tls_container_ref" : "ad9b123e858d4652b80e89b9941e49a4", "admin_state_up" : true, "loadbalancers" : [ { "id" : "309a0f61-0b62-45f2-97d1-742f3434338e" } ], "member_timeout" : 60, "client_timeout" : 60, "keepalive_timeout" : 15, "client_ca_tls_container_ref" : "7875ccb4c6b44cdb90ab2ab89892ab71", "project_id" : "99a3fff0d03c428eac3678da6a7d0f24", "sni_container_refs" : [ "7f41c96223d34ebaa3c8e836b6625ec0" ], "connection_limit" : -1, "default_pool_id" : "5e7e0175-d5d5-4f37-bfba-88a9524ad20b", "tls_ciphers_policy" : "tls-1-0", "tags" : [ ], "created_at" : "2019-03-22T23:37:14Z", "updated_at" : "2019-03-22T23:37:14Z", "http2_enable" : false, "ipgroup" : null, "insert_headers" : { "X-Forwarded-ELB-IP" : true }, "transparent_client_ip_enable" : false, "quic_config" : null } ], "page_info" : { "next_marker" : "0b455839-3ea7-4bac-ad26-35bf22f96ea4", "previous_marker" : "0b11747a-b139-492f-9692-2df0b1c87193", "current_count" : 2 }, "request_id" : "774640ee-6863-4de3-8156-aff16f51a087" }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
Consulta a los oyentes en cada página |
Códigos de error
Consulte Códigos de error.