ListListeners - - Centre de documentation Alibaba Cloud

Consulte les écouteurs des équilibreurs de charge de passerelle.

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

list

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
ListenerIds	array	Non	Les identifiants des écouteurs. Vous pouvez spécifier jusqu'à 20 identifiants d'écouteurs.
	string	Non	L'identifiant de l'écouteur.	lsn-w3t3vpgjj12b2i****
LoadBalancerIds	array	Non	Les identifiants des instances d'équilibreur de charge de passerelle (GWLB). Vous pouvez spécifier jusqu'à 20 identifiants d'instance.
	string	Non	L'identifiant de l'instance d'équilibreur de charge de passerelle (GWLB).	gwlb-rbtjolkkbudmrr****
NextToken	string	Non	Le jeton utilisé pour la requête suivante. Valeurs valides : Si NextToken est vide, aucune requête ultérieure n'est effectuée. Si une valeur est renvoyée pour NextToken, cette valeur est le jeton utilisé pour la requête suivante.	d209f4e63ec942c967c50c888a13****
MaxResults	integer	Non	Le nombre d'entrées à renvoyer sur chaque page. Valeurs valides : 1 à 1000. Valeur par défaut : 20.	20
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. La clé de balise ne peut pas être une chaîne vide. La clé de balise peut comporter jusqu'à 128 caractères et ne peut pas commencer par `aliyun` ou `acs:`. La clé de balise ne peut pas contenir `http://` ou `https://`.	tagKey
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://`.	tagValue
Skip	integer	Non	Le nombre d'entrées à ignorer pour une requête paginée.	10

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les données renvoyées.
Listeners	array<object>	Une liste des écouteurs de l'instance d'équilibreur de charge de passerelle (GWLB).
	array<object>	Les informations sur l'écouteur.
ListenerDescription	string	La description de l'écouteur.	listener-description
ListenerId	string	L'identifiant de l'écouteur.	lsn-vu7folhh5ntm8u****
ListenerStatus	string	L'état de l'écouteur. Valeurs valides : Provisioning : l'écouteur est en cours de création. Running : l'écouteur est en cours d'exécution. Configuring : l'écouteur est en cours de configuration. Deleting : l'écouteur est en cours de suppression.	Running
LoadBalancerId	string	L'identifiant de l'instance d'équilibreur de charge de passerelle (GWLB).	gwlb-uf6hbeh795xlqln7g****
ServerGroupId	string	L'identifiant du groupe de serveurs.	sgp-5yapcb422i51ru****
TcpIdleTimeout	integer	Le délai d'expiration d'une connexion TCP inactive.	350
Tags	array<object>	Les balises.
	object	Les balises.
Key	string	The tag key.	testKey
Value	string	The tag value.	testValue
MaxResults	integer	Le nombre d'entrées renvoyées sur chaque page. Valeurs valides : 1 à 1000. Valeur par défaut : 20.	20
NextToken	string	Le jeton utilisé pour la requête suivante. Valeurs valides : Si NextToken est vide, aucune requête ultérieure n'est effectuée. Si une valeur est renvoyée pour NextToken, cette valeur est le jeton utilisé pour la requête suivante.	5c281c0a0d6bfb6355ed088c2108aca8e0b5e8707e68****
RequestId	string	L'identifiant de la requête.	7DBFC67C-A272-5952-8287-6C3EBE4E04D9
TotalCount	integer	Le nombre total d'entrées.	8

Exemples

JSON format

{
  "Listeners": [
    {
      "ListenerDescription": "listener-description",
      "ListenerId": "lsn-vu7folhh5ntm8u****",
      "ListenerStatus": "Running",
      "LoadBalancerId": "gwlb-uf6hbeh795xlqln7g****",
      "ServerGroupId": "sgp-5yapcb422i51ru****",
      "TcpIdleTimeout": 350,
      "Tags": [
        {
          "Key": "testKey",
          "Value": "testValue"
        }
      ]
    }
  ],
  "MaxResults": 20,
  "NextToken": "5c281c0a0d6bfb6355ed088c2108aca8e0b5e8707e68****",
  "RequestId": "7DBFC67C-A272-5952-8287-6C3EBE4E04D9",
  "TotalCount": 8
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	MissingParam.TagKey	The param of TagKey is missing.	The parameter of tag key is missing.
400	DuplicatedParam.TagKey	The param of %s is duplicated.	The parameter of tag key is duplicated.

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

Notes de version

Consultez Notes de version pour la liste complète.