UpdateListenerAttribute - - Centre de documentation Alibaba Cloud

Met à jour la configuration d'un écouteur, telle que le nom et les actions par défaut.

Description de l'opération

L'opération UpdateListenerAttribute est asynchrone. Une fois l'identifiant de requête renvoyé, la tâche de mise à jour de la configuration de l'écouteur est toujours en cours. Vous pouvez appeler GetListenerAttribute pour interroger l'état de mise à jour de la configuration de l'écouteur :

Si l'écouteur est dans l'état Configuring, la configuration de l'écouteur est en cours de mise à jour.
Si l'écouteur est dans l'état Running, la configuration de l'écouteur a été mise à jour.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

alb:UpdateListenerAttribute

update

*LoadBalancer

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

*SecurityPolicy

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

*ServerGroup

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
ListenerId	string	Oui	L'identifiant de l'écouteur de l'instance Application Load Balancing (ALB).	lsn-o4u54y73wq7b******
ClientToken	string	Non	Le jeton client utilisé pour garantir l'idempotence de la requête. Vous pouvez utiliser le client pour générer le jeton, mais vous devez vous assurer que le jeton est unique parmi les différentes requêtes. Le jeton ne peut contenir que des caractères ASCII. Remarque Si vous ne spécifiez pas ce paramètre, le système utilise automatiquement la valeur RequestId comme valeur ClientToken. La valeur RequestId est différente pour chaque requête d'API.	5A2CFF0E-5718-45B5-9D4D-70B******
DryRun	boolean	Non	Indique si un test à blanc uniquement doit être effectué, sans exécuter la requête réelle. Valeurs valides : true : effectue uniquement un test à blanc. Le système vérifie la requête pour détecter d'éventuels problèmes, notamment les valeurs de paramètres manquantes, la syntaxe de requête incorrecte et les limites de service. Si la requête échoue au test à blanc, un code d'erreur est renvoyé. Si la requête réussit le test à blanc, le code d'erreur `DryRunOperation` est renvoyé. false (par défaut) : effectue un test à blanc et exécute la requête réelle. Si la requête réussit le test à blanc, un code d'état `HTTP 2xx` est renvoyé et l'opération est exécutée.	false
ListenerDescription	string	Non	Le nom personnalisé de l'écouteur. Le nom doit comporter de 2 à 256 caractères et peut contenir des lettres, des chiffres, des caractères chinois, des virgules (,), des points (.), des points-virgules (;), des barres obliques (/), des arobases (@), des traits de soulignement (_) et des traits d'union (-).	HTTP_80
RequestTimeout	integer	Non	Le délai d'expiration de la requête. Unité : secondes. Valeurs valides : 1 à 600. Si aucune réponse n'est reçue du serveur back-end pendant le délai d'expiration de la requête, l'équilibreur de charge envoie un code d'erreur `HTTP 504` au client.	60
IdleTimeout	integer	Non	Le délai d'expiration de la connexion inactive. Unité : secondes. Valeurs valides : 1 à 600. Si aucune requête d'accès n'est reçue pendant le délai d'expiration de la connexion inactive, l'équilibrage de charge interrompt temporairement la connexion en cours. Lorsqu'une nouvelle requête est reçue, une nouvelle connexion est établie.	15
GzipEnabled	boolean	Non	Indique si la compression Gzip doit être activée pour compresser des types de fichiers spécifiques. Valeurs valides : true : activée. false : désactivée.	true
Http2Enabled	boolean	Non	Indique si HTTP/2 doit être activé. Valeurs valides : true : activé. false : désactivé. Remarque Seuls les écouteurs HTTPS prennent en charge ce paramètre.	true
SecurityPolicyId	string	Non	La stratégie de sécurité. Les stratégies de sécurité système et les stratégies de sécurité personnalisées sont prises en charge. Remarque Seuls les écouteurs HTTPS prennent en charge ce paramètre.	tls_cipher_policy_1_0
CaEnabled	boolean	Non	Indique si l'authentification mutuelle doit être activée. Valeurs valides :\n- true : activé.\n- false : désactivé.	false
XForwardedForConfig	object	Non	La configuration de la fonctionnalité XForwardedFor.
XForwardedForClientCertClientVerifyAlias	string	Non	Le nom du champ d'en-tête personnalisé. Ce paramètre ne prend effet que lorsque XForwardedForClientCertClientVerifyEnabled est défini sur true.\n\nLe nom doit comporter de 1 à 40 caractères et peut contenir des lettres minuscules de a à z, des traits d'union (-), des traits de soulignement (_) et des chiffres.\n\n> Seuls les écouteurs HTTPS prennent en charge ce paramètre.	test_client-verify-alias_123456
XForwardedForClientCertClientVerifyEnabled	boolean	Non	Indique si l'en-tête `X-Forwarded-Clientcert-clientverify` doit être utilisé pour récupérer le résultat de la vérification du certificat client qui accède à l'instance d'équilibreur de charge. Valeurs valides : true : activé. false : désactivé. Remarque Seuls les écouteurs HTTPS prennent en charge ce paramètre.	false
XForwardedForClientCertFingerprintAlias	string	Non	Le nom du champ d'en-tête personnalisé. Ce paramètre prend effet uniquement lorsque XForwardedForClientCertFingerprintEnabled est défini sur true. Le nom doit comporter de 1 à 40 caractères et peut contenir des lettres minuscules de a à z, des traits d'union (-), des traits de soulignement (_) et des chiffres. Remarque Seuls les écouteurs HTTPS prennent en charge ce paramètre.	test_finger-print-alias_123456
XForwardedForClientCertFingerprintEnabled	boolean	Non	Indique s'il faut utiliser l'en-tête `X-Forwarded-Clientcert-fingerprint` pour récupérer l'empreinte du certificat client qui accède à l'instance d'équilibrage de charge. Valeurs valides :\n- true : activé.\n- false : désactivé.\n\n> Seuls les écouteurs HTTPS prennent en charge ce paramètre.	false
XForwardedForClientCertIssuerDNAlias	string	Non	Le nom du champ d'en-tête personnalisé. Ce paramètre ne prend effet que lorsque XForwardedForClientCertIssuerDNEnabled est défini sur true. Le nom doit comporter de 1 à 40 caractères et peut contenir des lettres minuscules de a à z, des traits d'union (-), des traits de soulignement (_) et des chiffres. Remarque Seuls les écouteurs HTTPS prennent en charge ce paramètre.	test_issue-dn-alias_123456
XForwardedForClientCertIssuerDNEnabled	boolean	Non	Indique si l'en-tête `X-Forwarded-Clientcert-issuerdn` doit être utilisé pour récupérer les informations sur l'émetteur du certificat client qui accède à l'instance d'équilibrage de charge. Valeurs valides :\n- true : activé.\n- false : désactivé.\n\n> Seuls les écouteurs HTTPS prennent en charge ce paramètre.	false
XForwardedForClientCertSubjectDNAlias	string	Non	Le nom du champ d'en-tête personnalisé. Ce paramètre prend effet uniquement lorsque XForwardedForClientCertSubjectDNEnabled est défini sur true. Le nom doit comporter de 1 à 40 caractères et peut contenir des lettres minuscules de a à z, des traits d'union (-), des traits de soulignement (_) et des chiffres. Remarque Seuls les écouteurs HTTPS prennent en charge ce paramètre.	test_subject-dn-alias_123456
XForwardedForClientCertSubjectDNEnabled	boolean	Non	Indique si l'en-tête `X-Forwarded-Clientcert-subjectdn` doit être utilisé pour récupérer les informations sur le propriétaire du certificat client qui accède à l'instance d'équilibrage de charge. Valeurs valides : true : activé. false : désactivé. Remarque Seuls les écouteurs HTTPS prennent en charge ce paramètre.	false
XForwardedForClientSrcPortEnabled	boolean	Non	Indique s'il faut utiliser l'en-tête `X-Forwarded-Client-srcport` pour récupérer le port du client qui accède à l'instance d'équilibrage de charge. Valeurs valides :\n- true : activé.\n- false : désactivé.\n\n> Les écouteurs HTTP et HTTPS prennent en charge ce paramètre.	false
XForwardedForEnabled	boolean	Non	Indique s'il faut utiliser l'en-tête `X-Forwarded-For` pour récupérer l'adresse IP réelle du client. Valeurs valides : true (par défaut) : activé. false : désactivé. Remarque Si vous définissez ce paramètre sur true, XForwardedForProcessingMode prend la valeur par défaut append et peut être modifié en remove. Si vous définissez ce paramètre sur false, l'en-tête `X-Forwarded-For` est conservé sans traitement supplémentaire avant que la requête ne soit envoyée au serveur back-end. Les écouteurs HTTP et HTTPS prennent en charge ce paramètre.	true
XForwardedForProcessingMode	string	Non	Le mode de traitement de l'en-tête `X-Forwarded-For`. Ce paramètre prend effet uniquement lorsque XForwardedForEnabled est défini sur true. Valeurs valides : append (par défaut) : ajoute l'adresse IP. remove : supprime l'en-tête. Remarque Si vous définissez ce paramètre sur append, l'adresse IP du dernier saut est ajoutée à l'en-tête `X-Forwarded-For` avant que la requête ne soit envoyée au serveur back-end. Si vous définissez ce paramètre sur remove, l'en-tête `X-Forwarded-For` est supprimé avant que la requête ne soit envoyée au serveur back-end, que la requête contienne ou non l'en-tête `X-Forwarded-For`. Les écouteurs HTTP et HTTPS prennent en charge ce paramètre.	append
XForwardedForProtoEnabled	boolean	Non	Indique si l'en-tête `X-Forwarded-Proto` doit être utilisé pour obtenir le protocole de l'écouteur de l'instance d'équilibrage de charge. Valeurs valides : true : activé. false : désactivé. Remarque Les écouteurs HTTP, HTTPS et QUIC prennent en charge ce paramètre.	false
XForwardedForSLBIdEnabled	boolean	Non	Indique si l'en-tête `SLB-ID` doit être utilisé pour récupérer l'identifiant de l'instance d'équilibrage de charge. Valeurs valides :\n- true : activé.\n- false : désactivé.\n\n> Les écouteurs HTTP, HTTPS et QUIC prennent en charge ce paramètre.	false
XForwardedForSLBPortEnabled	boolean	Non	Indique s'il faut utiliser l'en-tête X-Forwarded-Port pour récupérer le port d'écoute de l'instance d'équilibrage de charge. Valeurs valides : true : activé. false : désactivé. Remarque Les écouteurs HTTP, HTTPS et QUIC prennent en charge ce paramètre.	false
XForwardedForClientSourceIpsEnabled	boolean	Non	Indique si ALB est autorisé à récupérer l'adresse IP réelle du client à partir de l'en-tête X-Forwarded-For. Valeurs valides : true : activé. false : désactivé. Remarque Les écouteurs HTTP et HTTPS prennent en charge ce paramètre.	false
XForwardedForClientSourceIpsTrusted	string	Non	Les adresses IP des proxys de confiance. L'Application Load Balancer (ALB) parcourt l'en-tête `X-Forwarded-For` de droite à gauche et sélectionne la première adresse IP qui ne figure pas dans la liste des adresses IP de confiance comme adresse IP réelle du client. Cette adresse IP est utilisée pour la limitation de débit basée sur l'adresse IP source.	10.1.1.0/24
XForwardedForHostEnabled	boolean	Non	Indique s'il faut utiliser l'en-tête `X-Forwarded-Host` pour récupérer le nom de domaine du client qui accède à l'instance d'équilibrage de charge. Valeurs valides : true : activé. false (par défaut) : désactivé. Remarque Les écouteurs HTTP, HTTPS et QUIC prennent en charge ce paramètre.	false
QuicConfig	object	Non	Les informations de configuration lorsque l'association d'écouteur QUIC est activée.
QuicListenerId	string	Non	L'identifiant de l'écouteur QUIC à associer. Ce paramètre est requis lorsque QuicUpgradeEnabled est défini sur true. Ce paramètre est valide pour les écouteurs HTTPS. Remarque L'écouteur d'origine et l'écouteur QUIC associé doivent appartenir à la même instance ALB, et l'écouteur QUIC ne doit pas avoir été associé au préalable.	lsn-333
QuicUpgradeEnabled	boolean	Non	Indique si la mise à niveau QUIC doit être activée. Valeurs valides : true : activé. false : désactivé. Remarque Ce paramètre est valide uniquement pour les écouteurs HTTPS.	false
Certificates	array<object>	Non	La liste des certificats.
	object	Non	La structure du certificat.
CertificateId	string	Non	L'identifiant du certificat par défaut. Un seul certificat de serveur par défaut est pris en charge. Remarque Ce paramètre est requis lorsque le type de protocole de l'écouteur est HTTPS ou QUIC. Pour ajouter d'autres certificats de serveur après la création de l'écouteur, appelez AssociateAdditionalCertificatesWithListener pour configurer des certificats d'extension.	123157******
CaCertificates	array<object>	Non	La liste des certificats CA. Un seul certificat CA est pris en charge.
	object	Non	La structure du certificat CA.
CertificateId	string	Non	L'identifiant du certificat CA. Remarque Ce paramètre est obligatoire lorsque CaEnabled est défini sur true.	123359******
DefaultActions	array<object>	Non	La liste des actions de règle par défaut.
	array<object>	Non	La structure de l'action de règle par défaut.
ForwardGroupConfig	object	Non	La configuration de l'action de transfert. Ce paramètre est requis et valide lorsque Type est défini sur ForwardGroup. Un maximum de 20 configurations d'actions de transfert peuvent être ajoutées.
ServerGroupTuples	array<object>	Oui	La liste des tuples de groupes de serveurs de destination du transfert.
	object	Non	La structure du tuple de groupe de serveurs de destination du transfert.
ServerGroupId	string	Oui	The ID of the destination server group to which requests are forwarded.	sgp-i5qt20******
Type	string	Oui	Le type d'action. Un maximum d'un type d'action peut être ajouté. Valeurs valides : ForwardGroup, ce qui indique que les requêtes sont acheminées vers plusieurs groupes de serveurs.	ForwardGroup

Éléments de réponse

Élément	Type	Description	Exemple
	object	La structure de la réponse.
JobId	string	L'identifiant de la tâche asynchrone.	72dcd26b-f12d-4c27-b3af-18f6aed5****
RequestId	string	L'identifiant de la requête.	365F4154-92F6-4AE4-92F8-7FF******

Exemples

JSON format

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

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	IncorrectStatus.LoadBalancer	The status of %s [%s] is incorrect.
400	IncorrectBusinessStatus.LoadBalancer	The business status of %s [%s] is incorrect.	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.	The operation is not allowed because of %s.
400	ResourceAlreadyAssociated.Listener	The specified resource %s is already associated.	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.	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.	The operation is not allowed because the server group protocol is not supported.
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.	The specified resource of %s is being configured, please try again later.
400	Mismatch.VpcId	The %s is mismatched for %s and %s.	The %s is mismatched for %s and %s.
400	InvalidParameter	Invalid parameter, please check the parameter input.	Invalid parameter, please check the parameter input.
400	OperationDenied.CACertificateCorrupted	The CA certificate is corrupted.	CA certificate is corrupted
403	Forbidden.LoadBalancer	Authentication is failed for %s.	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.	The specified resource %s is not found.
404	ResourceNotFound.Certificate	The specified resource %s is not found.	The specified resource %s is not found.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.