Actualización de un oyente
Función
Esta API se utiliza para actualizar un oyente.
Restricciones
Si el estado de aprovisionamiento del balanceador de carga al que se añade el oyente no es ACTIVE, el oyente no se puede actualizar.
URI
PUT /v3/{project_id}/elb/listeners/{listener_id}
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
listener_id |
Sí |
String |
Especifica el ID de oyente. |
project_id |
Sí |
String |
Especifica el ID del tenant. |
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ámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
listener |
Sí |
UpdateListenerOption object |
Especifica el oyente. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
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. |
client_ca_tls_container_ref |
No |
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. El protocolo QUIC no se admite en la región eu-nl. |
default_pool_id |
No |
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. Mínimo: 1 Máximo: 36 |
default_tls_container_ref |
No |
String |
Especifica el ID del certificado de servidor utilizado por el oyente. Este parámetro solo está disponible cuando el protocolo del oyente es HTTPS y type se establece en server. |
description |
No |
String |
Proporciona información complementaria sobre el oyente. Mínimo: 0 Máximo: 255 |
http2_enable |
No |
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 se admite en la región eu-nl. |
insert_headers |
No |
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. |
name |
No |
String |
Especifica el nombre de oyente. Mínimo: 0 Máximo: 255 |
sni_container_refs |
No |
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 |
No |
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. |
tls_ciphers_policy |
No |
String |
Especifica la política de seguridad utilizada por el oyente. Nota:
El protocolo QUIC no se admite en la región eu-nl. |
security_policy_id |
No |
String |
Especifica el ID de la política de seguridad personalizada. Nota:
Mínimo: 1 Máximo: 36 |
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). El valor predeterminado es true. Nota:
El protocolo QUIC no se admite en la región eu-nl. |
member_timeout |
No |
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. Este parámetro solo está disponible para oyentes HTTP y HTTPS. Mínimo: 1 Máximo: 300 |
client_timeout |
No |
Integer |
Especifica la duración del tiempo de espera de una respuesta de un cliente, en segundos. Este parámetro solo está disponible para oyentes HTTP y HTTPS. El valor varía de 1 a 300. Mínimo: 1 Máximo: 300 |
keepalive_timeout |
No |
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.
|
ipgroup |
No |
UpdateListenerIpGroupOption object |
Especifica el grupo de direcciones IP asociado al oyente. |
transparent_client_ip_enable |
No |
Boolean |
Especifica si se deben pasar las direcciones IP de origen de los clientes a los servidores backend.
Nota:
|
enhance_l7policy_enable |
No |
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. |
quic_config |
No |
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 |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Forwarded-ELB-IP |
No |
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 |
No |
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 |
No |
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 |
No |
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 |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
ipgroup_id |
No |
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. Mínimo: 1 Máximo: 36 |
enable_ipgroup |
No |
Boolean |
Especifica si el control de acceso está habilitado.
Un oyente con control de acceso habilitado se puede eliminar directamente. |
type |
No |
String |
Especifica cómo se controla el acceso al oyente.
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
quic_listener_id |
No |
String |
Especifica el ID del QUIC oyente. Especifica el oyente especificado. 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 |
No |
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. |
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. |
listener |
Listener object |
Especifica el oyente. |
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 oyente de 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 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
PUT https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/listeners/0b11747a-b139-492f-9692-2df0b1c87193 { "listener" : { "description" : "My listener update.", "name" : "My listener", "http2_enable" : true } }
Ejemplo de las respuestas
Código de estado: 200
Solicitud exitosa.
{ "listener" : { "id" : "0b11747a-b139-492f-9692-2df0b1c87193", "name" : "My listener", "protocol_port" : 80, "protocol" : "TCP", "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, "ipgroup" : null, "insert_headers" : { "X-Forwarded-ELB-IP" : true }, "transparent_client_ip_enable" : false }, "request_id" : "5d56d89a-2271-4a75-8c02-804e3bc7b671" }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
Solicitud exitosa. |
Códigos de error
Consulte Códigos de error.