CreateListener - - Centre de documentation Alibaba Cloud

Crée un écouteur pour une instance Gateway Load Balancer (GWLB).

Description de l'opération

L'opération CreateListener est asynchrone. Après l'envoi d'une requête, le système renvoie un identifiant de requête. L'écouteur est créé en arrière-plan. Vous pouvez appeler l'opération GetListenerAttribute pour interroger l'état de création de l'écouteur :\n\n- Si un écouteur est dans l'état Provisioning, l'écouteur est en cours de création.\n\n- Si un écouteur est dans l'état Running, l'écouteur est créé.

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:CreateListener

create

*LoadBalancer

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

*ServerGroup

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

*Listener

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
LoadBalancerId	string	Oui	L'identifiant de l'instance GWLB.	gwlb-te609d6696632f7*****
ListenerDescription	string	Non	La description de l'écouteur.\n\nLa description doit comporter entre 2 et 256 caractères. Elle peut contenir des caractères chinois, 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	Oui	L'identifiant du groupe de serveurs.	sgp-ckh01px70dszof****
TcpIdleTimeout	integer	Non	Le délai d'expiration d'une connexion TCP inactive.\n\nValeurs valides : 60 à 6000 secondes.\n\nValeur par défaut : 350 secondes.	350
DryRun	boolean	Non	Indique si un test à blanc doit être effectué. Valeurs valides :\n\n- 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é.\n\n- false (par défaut) : envoie la requête. Si la requête réussit la vérification, un code d'état HTTP 2xx est renvoyé et l'opération est effectuée.	false
ClientToken	string	Non	Le jeton client utilisé pour garantir l'idempotence de la requête.\n\nVous pouvez utiliser le client pour générer un 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.\n\n> Si vous ne spécifiez pas ce paramètre, le système utilise automatiquement le RequestId de la requête comme ClientToken. Le RequestId peut être différent pour chaque requête.	123e4567-e89b-12d3-a456-42665544****
Tag	array<object>	Non	Les balises. Vous pouvez spécifier jusqu'à 20 balises lors de chaque appel.
	object	Non	La balise.
Key	string	Non	La clé de balise. Si vous spécifiez ce paramètre, vous ne pouvez pas le laisser vide. La clé de balise peut comporter jusqu'à 128 caractères et ne peut pas commencer par `aliyun` ou `acs:`. Elle ne peut pas contenir `http://` ou `https://`.	testKey
Value	string	Non	La valeur de balise. La valeur de balise peut comporter jusqu'à 256 caractères et ne peut pas contenir `http://` ou `https://`.	testValue

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les données renvoyées.
ListenerId	string	L'identifiant de l'écouteur.	lsn-wi3c0v30ivysrg****
RequestId	string	L'identifiant de la requête.	A045E652-D298-5E70-A978-7247135336FB

Exemples

JSON format

{
  "ListenerId": "lsn-wi3c0v30ivysrg****",
  "RequestId": "A045E652-D298-5E70-A978-7247135336FB"
}

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	MissingParam.TagKey	The param of TagKey is missing.	The parameter of tag key is missing.
400	MissingParam.TagValue	The param of TagValue is missing.	The parameter of tag value is missing.
400	OperationDenied.TooManyListeners	The operation is not allowed because of TooManyListener.	The number of listeners of the load balancer instance exceeds the limit. The operation is denied.
400	IncorrectStatus.LoadBalancer	The status of %s [%s] is incorrect.	Resource %s current state %s does not support operation
400	ResourceInUse.IP	The specified resource of IP is in use.
400	Mismatch.VpcId	The %s is mismatched for %s and %s.	The VPC IDs of the two resources do not match.
400	IncorrectStatus.ServerGroup	The status of %s [%s] is incorrect.	The status of %s [%s] is incorrect.
400	DuplicatedParam.TagKey	The param of %s is duplicated.	The parameter of tag key is duplicated.
400	IllegalParam.TagKey	The param of %s is illegal.
400	IllegalParam.TagValue	The param of %s is illegal.	The parameter of tag value is illegal.
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.
404	ResourceNotFound.LoadBalancer	The specified resource of %s is not found.	The specified resource of .LoadBalancer 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.