UpdateListenerAttribute - Server Load Balancer - Centro de documentación de Alibaba Cloud

Actualiza la configuración de un listener, como el nombre y la acción predeterminada.

Descripción de la operación

UpdateListenerAttribute es una operación asíncrona. Después de que se devuelve un ID de solicitud, la actualización de la configuración del listener se sigue procesando en segundo plano. Puede llamar a GetListenerAttribute para consultar el estado de actualización de la configuración del listener:

Si el listener está en estado Configuring, la configuración del listener se está actualizando.
Si el listener está en estado Running, la configuración del listener se ha actualizado.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

alb:UpdateListenerAttribute

update

*LoadBalancer.

acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

*SecurityPolicy.

acs:alb:{#regionId}:{#accountId}:securitypolicy/{#securitypolicyId}

*ServerGroup.

acs:alb:{#regionId}:{#accountId}:servergroup/{#servergroupId}

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ListenerId	string	Sí	El ID del listener de la instancia de Application Load Balancing (ALB).	lsn-o4u54y73wq7b******
ClientToken	string	No	El token de cliente que se utiliza para garantizar la idempotencia de la solicitud. Puede utilizar el cliente para generar el token, pero debe asegurarse de que el token sea único entre diferentes solicitudes. El token solo puede contener caracteres ASCII. Nota Si no especifica este parámetro, el sistema utiliza automáticamente el RequestId como ClientToken. El RequestId puede ser diferente para cada solicitud de API.	5A2CFF0E-5718-45B5-9D4D-70B******
DryRun	boolean	No	Especifica si se debe realizar solo una ejecución de prueba, sin ejecutar la solicitud real. Valores válidos: true: realiza solo una ejecución de prueba. El sistema comprueba la solicitud en busca de posibles problemas, incluidos valores de parámetros faltantes, sintaxis de solicitud incorrecta y límites de servicio. Si la solicitud no supera la ejecución de prueba, se devuelve un código de error. Si la solicitud supera la ejecución de prueba, se devuelve el código de error `DryRunOperation`. false (predeterminado): realiza una ejecución de prueba y ejecuta la solicitud real. Si la solicitud supera la ejecución de prueba, se devuelve un código de estado `HTTP 2xx` y se realiza la operación.	false
ListenerDescription	string	No	El nombre personalizado del listener. El nombre debe tener entre 2 y 256 caracteres de longitud, y puede contener letras, dígitos, caracteres chinos, comas (,), puntos (.), punto y coma (;), barras diagonales (/), arrobas (@), guiones bajos (_) y guiones (-).	HTTP_80
RequestTimeout	integer	No	El tiempo de espera de la solicitud. Unidad: segundos. Valores válidos: 1 a 600. Si no se recibe respuesta del servidor backend dentro del período de tiempo de espera, el load balancing devuelve un código de error `HTTP 504` al cliente.	60
IdleTimeout	integer	No	El tiempo de espera de conexión inactiva. Unidad: segundos. Valores válidos: 1 a 600. Si no se recibe ninguna solicitud de acceso dentro del período de tiempo de espera, el load balancing interrumpe temporalmente la conexión actual y restablece la conexión cuando llega la siguiente solicitud.	15
GzipEnabled	boolean	No	Especifica si se debe habilitar la compresión Gzip para comprimir tipos específicos de archivos. Valores válidos: true: habilitado. false: deshabilitado.	true
Http2Enabled	boolean	No	Especifica si se debe habilitar HTTP/2. Valores válidos: true: habilitado. false: deshabilitado. Nota Solo los listeners HTTPS admiten este parámetro.	true
SecurityPolicyId	string	No	La política de seguridad. Se admiten políticas de seguridad del sistema y políticas de seguridad personalizadas. Nota Solo los listeners HTTPS admiten este parámetro.	tls_cipher_policy_1_0
CaEnabled	boolean	No	Especifica si se debe habilitar la autenticación mutua. Valores válidos: true: habilitado. false: deshabilitado.	false
XForwardedForConfig	object	No	La configuración de la función XForwardedFor.
XForwardedForClientCertClientVerifyAlias	string	No	El nombre del campo de encabezado personalizado. Este parámetro solo tiene efecto cuando XForwardedForClientCertClientVerifyEnabled se establece en true. El nombre debe tener entre 1 y 40 caracteres de longitud, y puede contener letras minúsculas de la a a la z, guiones (-), guiones bajos (_) y dígitos. Nota Solo los listeners HTTPS admiten este parámetro.	test_client-verify-alias_123456
XForwardedForClientCertClientVerifyEnabled	boolean	No	Especifica si se debe usar el campo de encabezado `X-Forwarded-Clientcert-clientverify` para obtener el resultado de verificación del certificado de cliente que accede a la instancia de load balancing. Valores válidos: true: habilitado. false: deshabilitado. Nota Solo los listeners HTTPS admiten este parámetro.	false
XForwardedForClientCertFingerprintAlias	string	No	El nombre del campo de encabezado personalizado. Este parámetro solo tiene efecto cuando XForwardedForClientCertFingerprintEnabled se establece en true. El nombre debe tener entre 1 y 40 caracteres de longitud, y puede contener letras minúsculas de la a a la z, guiones (-), guiones bajos (_) y dígitos. Nota Solo los listeners HTTPS admiten este parámetro.	test_finger-print-alias_123456
XForwardedForClientCertFingerprintEnabled	boolean	No	Especifica si se debe usar el campo de encabezado `X-Forwarded-Clientcert-fingerprint` para obtener la huella digital del certificado de cliente que accede a la instancia de load balancing. Valores válidos: true: habilitado. false: deshabilitado. Nota Solo los listeners HTTPS admiten este parámetro.	false
XForwardedForClientCertIssuerDNAlias	string	No	El nombre del campo de encabezado personalizado. Este parámetro solo tiene efecto cuando XForwardedForClientCertIssuerDNEnabled se establece en true. El nombre debe tener entre 1 y 40 caracteres de longitud, y puede contener letras minúsculas de la a a la z, guiones (-), guiones bajos (_) y dígitos. Nota Solo los listeners HTTPS admiten este parámetro.	test_issue-dn-alias_123456
XForwardedForClientCertIssuerDNEnabled	boolean	No	Especifica si se debe usar el campo de encabezado `X-Forwarded-Clientcert-issuerdn` para obtener la información del emisor del certificado de cliente que accede a la instancia de load balancing. Valores válidos: true: habilitado. false: deshabilitado. Nota Solo los listeners HTTPS admiten este parámetro.	false
XForwardedForClientCertSubjectDNAlias	string	No	El nombre del campo de encabezado personalizado. Este parámetro solo tiene efecto cuando XForwardedForClientCertSubjectDNEnabled se establece en true. El nombre debe tener entre 1 y 40 caracteres de longitud, y puede contener letras minúsculas de la a a la z, guiones (-), guiones bajos (_) y dígitos. Nota Solo los listeners HTTPS admiten este parámetro.	test_subject-dn-alias_123456
XForwardedForClientCertSubjectDNEnabled	boolean	No	Especifica si se debe usar el campo de encabezado `X-Forwarded-Clientcert-subjectdn` para obtener la información del propietario del certificado de cliente que accede a la instancia de load balancing. Valores válidos: true: habilitado. false: deshabilitado. Nota Solo los listeners HTTPS admiten este parámetro.	false
XForwardedForClientSrcPortEnabled	boolean	No	Especifica si se debe usar el campo de encabezado `X-Forwarded-Client-srcport` para obtener el puerto del cliente que accede a la instancia de load balancing. Valores válidos: true: habilitado. false: deshabilitado. Nota Los listeners HTTP y HTTPS admiten este parámetro.	false
XForwardedForEnabled	boolean	No	Especifica si se debe usar el campo de encabezado `X-Forwarded-For` para obtener la dirección IP real del cliente. Valores válidos: true (predeterminado): habilitado. false: deshabilitado. Nota Si establece este parámetro en true, XForwardedForProcessingMode toma el valor predeterminado append y se puede cambiar a remove. Si establece este parámetro en false, el campo de encabezado `X-Forwarded-For` se conserva sin procesamiento adicional antes de enviar la solicitud al servidor backend. Los listeners HTTP y HTTPS admiten este parámetro.	true
XForwardedForProcessingMode	string	No	El modo de procesamiento para el campo de encabezado `X-Forwarded-For`. Este parámetro solo tiene efecto cuando XForwardedForEnabled se establece en true. Valores válidos: append (predeterminado): anexar. remove: eliminar. Nota Si establece este parámetro en append, la dirección IP del último salto se anexa al campo de encabezado `X-Forwarded-For` antes de enviar la solicitud al servidor backend. Si establece este parámetro en remove, el encabezado `X-Forwarded-For` se elimina antes de enviar la solicitud al servidor backend, independientemente de si la solicitud contiene el campo de encabezado `X-Forwarded-For`. Los listeners HTTP y HTTPS admiten este parámetro.	append
XForwardedForProtoEnabled	boolean	No	Especifica si se debe usar el campo de encabezado `X-Forwarded-Proto` para obtener el protocolo del listener de la instancia de load balancing. Valores válidos: true: habilitado. false: deshabilitado. Nota Los listeners HTTP, HTTPS y QUIC admiten este parámetro.	false
XForwardedForSLBIdEnabled	boolean	No	Especifica si se debe usar el campo de encabezado `SLB-ID` para obtener el ID de la instancia de load balancing. Valores válidos: true: habilitado. false: deshabilitado. Nota Los listeners HTTP, HTTPS y QUIC admiten este parámetro.	false
XForwardedForSLBPortEnabled	boolean	No	Especifica si se debe usar el campo de encabezado `X-Forwarded-Port` para obtener el puerto del listener de la instancia de load balancing. Valores válidos: true: habilitado. false: deshabilitado. Nota Los listeners HTTP, HTTPS y QUIC admiten este parámetro.	false
XForwardedForClientSourceIpsEnabled	boolean	No	Especifica si se permite que ALB obtenga la dirección IP real del cliente desde el campo de encabezado X-Forwarded-For. Valores válidos: true: habilitado. false: deshabilitado. Nota Los listeners HTTP y HTTPS admiten este parámetro.	false
XForwardedForClientSourceIpsTrusted	string	No	Las direcciones IP de proxy de confianza. Application Load Balancing (ALB) recorre el campo de encabezado `X-Forwarded-For` de derecha a izquierda y selecciona la primera dirección IP que no está en la lista de IP de confianza como la dirección IP real del cliente. Esta dirección IP se utiliza para la limitación de velocidad basada en la IP de origen.	10.1.1.0/24
XForwardedForHostEnabled	boolean	No	Especifica si se debe usar el campo de encabezado `X-Forwarded-Host` para obtener el nombre de dominio del cliente que accede a la instancia de load balancing. Valores válidos: true: habilitado. false (predeterminado): deshabilitado. Nota Los listeners HTTP, HTTPS y QUIC admiten este parámetro.	false
QuicConfig	object	No	La información de configuración cuando se habilita un listener QUIC asociado.
QuicListenerId	string	No	El ID del listener QUIC que se va a asociar. Este parámetro es obligatorio cuando QuicUpgradeEnabled se establece en true. Este parámetro solo es válido para listeners HTTPS. Nota El listener original y el listener QUIC asociado deben pertenecer a la misma instancia ALB, y el listener QUIC no debe haber sido asociado previamente.	lsn-333
QuicUpgradeEnabled	boolean	No	Especifica si se debe habilitar la actualización QUIC. Valores válidos: true: habilitado. false: deshabilitado. Nota Este parámetro solo es válido para listeners HTTPS.	false
Certificates	array<object>	No	La lista de certificados.
	object	No	La estructura del certificado.
CertificateId	string	No	El ID del certificado predeterminado. Solo se admite un certificado de servidor predeterminado. Nota Este parámetro es obligatorio cuando el tipo de protocolo del listener es HTTPS o QUIC. Para agregar más certificados de servidor, invoque AssociateAdditionalCertificatesWithListener para configurar certificados de extensión después de crear el listener.	123157******
CaCertificates	array<object>	No	La lista de certificados CA. Solo se admite un certificado CA.
	object	No	La estructura del certificado CA.
CertificateId	string	No	El ID del certificado CA. Nota Este parámetro es obligatorio cuando CaEnabled se establece en true.	123359******
DefaultActions	array<object>	No	La lista de acciones de regla predeterminadas.
	array<object>	No	La estructura de la acción de regla predeterminada.
ForwardGroupConfig	object	No	La configuración de reenvío para la acción. Este parámetro es obligatorio y válido solo cuando Type se establece en ForwardGroup. Puede agregar hasta 20 configuraciones de acción de reenvío.
ServerGroupTuples	array<object>	Sí	La lista de tuplas de grupos de servidores de destino de reenvío.
	object	No	La estructura de la tupla del grupo de servidores de destino de reenvío.
ServerGroupId	string	Sí	El ID del grupo de servidores de destino al que se reenvían las solicitudes.	sgp-i5qt20******
Type	string	Sí	El tipo de acción. Puede agregar hasta un tipo de acción. Valores válidos: ForwardGroup, que indica que las solicitudes se reenvían a múltiples grupos de servidores.	ForwardGroup

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	La estructura de la respuesta.
JobId	string	El ID de la tarea asíncrona.	72dcd26b-f12d-4c27-b3af-18f6aed5****
RequestId	string	El ID de la solicitud.	365F4154-92F6-4AE4-92F8-7FF******

Ejemplos

Respuesta exitosa

JSON Formato

{
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF******"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	IncorrectStatus.LoadBalancer	The status of %s [%s] is incorrect.
400	IncorrectBusinessStatus.LoadBalancer	The business status of %s [%s] is incorrect.
400	IncorrectStatus.Listener	The status of %s [%s] is incorrect.
400	OperationDenied.CrossLoadBalancerQUICListener	The operation is not allowed because of %s.
400	ResourceAlreadyAssociated.Listener	The specified resource %s is already associated.
400	OperationDenied.GRPCServerGroup	The operation is not allowed because of %s.
400	ResourceAlreadyAssociated.Certificate	The specified resource %s is already associated.
400	ResourceQuotaExceeded.SecurityPolicyAttachedNum	The quota of %s is exceeded for resource %s, usage %s/%s.
400	ResourceQuotaExceeded.ServerGroupAttachedNum	The quota of %s is exceeded for resource %s, usage %s/%s.
400	ResourceQuotaExceeded.LoadBalancerServersNum	The quota of %s is exceeded for resource %s, usage %s/%s.
400	ResourceQuotaExceeded.ServerAddedNum	The quota of %s is exceeded for resource %s, usage %s/%s.
400	OperationDenied.ServerGroupProtocolNotSupport	The operation is not allowed because of ServerGroupProtocolNotSupport.
400	UnsupportedFeature.FullTraceHttps	The feature of FullTraceHttps is not supported for current instance.
400	ResourceInConfiguring.Listener	The specified resource of %s is being configured, please try again later.
400	Mismatch.VpcId	The %s is mismatched for %s and %s.
400	InvalidParameter	Invalid parameter, please check the parameter input.
400	OperationDenied.CACertificateCorrupted	The CA certificate is corrupted.
403	Forbidden.LoadBalancer	Authentication is failed for %s.
404	ResourceNotFound.Listener	The specified resource %s is not found.
404	ResourceNotFound.ServerGroup	The specified resource %s is not found.
404	ResourceNotFound.SecurityPolicy	The specified resource %s is not found.
404	ResourceNotFound.Certificate	The specified resource %s is not found.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.