UpdateListenerAttribute - - Centre de documentation Alibaba Cloud

Met à jour les propriétés d'un écouteur.

Description de l'opération

L'opération UpdateListenerAttribute est asynchrone. Après l'envoi d'une requête, le système renvoie un identifiant de requête. La configuration de l'écouteur est ensuite mise à jour en arrière-plan. Vous pouvez appeler l'opération GetListenerAttribute pour interroger l'état de mise à jour de l'écouteur :

Si un écouteur est dans l'état Configuring, la configuration de l'écouteur est en cours de mise à jour.
Si un écouteur est dans l'état Running, la configuration de l'écouteur est 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.

gwlb:UpdateListenerAttribute

update

*LoadBalancer

acs:gwlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

*Listener

acs:gwlb:{#regionId}:{#accountId}:listener/{#ListenerId}

ServerGroup

acs:gwlb:{#regionId}:{#accountId}:servergroup/{#ServerGroupId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
ListenerId	string	Oui	L'identifiant de l'écouteur.	lsn-lxce8iqbof2vl0****
ListenerDescription	string	Non	La description de l'écouteur. La description doit comporter entre 2 et 256 caractères et peut contenir des lettres, des chiffres, des virgules (,), des points (.), des points-virgules (;), des barres obliques (/), des arobases (@), des traits de soulignement (_) et des traits d'union (-).	listener_description
ServerGroupId	string	Non	L'identifiant du groupe de serveurs.	sgp-sp8d2r6y7t0xtl****
TcpIdleTimeout	integer	Non	Le délai d'expiration d'une connexion TCP inactive. Valeurs valides : 60 à 6000. Unité : secondes.	350
DryRun	boolean	Non	Indique si un test à blanc doit être effectué. Valeurs valides : true : effectue un test à blanc. Le système vérifie les paramètres requis, le format de la requête et les limites du service. Si la requête échoue au test à blanc, un message 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 une requête normale. Si la requête réussit la vérification, un code d'état HTTP 2xx est renvoyé et l'opération est exécutée.	false
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 pour chaque requête. 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 le RequestId de la requête comme ClientToken. Le RequestId de chaque requête est différent.	123e4567-e89b-12d3-a456-42665544****

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les données renvoyées.
RequestId	string	L'identifiant de la requête.	7DBFC67C-A272-5952-8287-6C3EBE4E04D9

Exemples

JSON format

{
  "RequestId": "7DBFC67C-A272-5952-8287-6C3EBE4E04D9"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	IncorrectBusinessStatus.LoadBalancer	The business status of %s [%s] is incorrect.	Resource %s with business state %s does not support current operation
400	IncorrectStatus.LoadBalancer	The status of %s [%s] is incorrect.	Resource %s current state %s does not support operation
400	IncorrectStatus.Listener	The status of %s [%s] is incorrect.	Operation not supported for resource% s in current state% s.
400	Mismatch.VpcId	The %s is mismatched for %s and %s.	The VPC IDs of the two resources do not match.
400	ResourceInUse.IP	The specified resource of IP is in use.
400	IncorrectStatus.ServerGroup	The status of %s [%s] is incorrect.	The status of %s [%s] is incorrect.
400	OperationDenied.TcpIdleTimeoutConflictWithScheduler	The TCP idle timeout of listener must be default value when the scheduling algorithm of server group is not 5TCH.	The TCP idle timeout of listener must be default value when the scheduling algorithm of server group is not 5TCH.
400	OperationDenied.TcpIdleTimeoutNotConfigurable	The TCP idle timeout of listener is configurable only when the scheduling algorithm of server group is 5TCH.	The TCP idle timeout of listener is configurable only when the scheduling algorithm of server group is 5TCH.
404	ResourceNotFound.LoadBalancer	The specified resource of %s is not found.	The specified resource of .LoadBalancer is not found.
404	ResourceNotFound.Listener	The specified resource of %s is not found.	The specified resource of %s is not found.
404	ResourceNotFound.ServerGroup	The specified resource of %s is not found.	The specified server group resource does not exist.

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

Notes de version

Consultez Notes de version pour la liste complète.