GetListenerAttribute - - Centre de documentation Alibaba Cloud

Consulte les attributs d'un écouteur d'une instance Gateway Load Balancer (GWLB).

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

get

*LoadBalancer

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

*Listener

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
ListenerId	string	Oui	L'identifiant de l'écouteur.	lsn-brx2y3hqdinciz****

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les données renvoyées.
ListenerDescription	string	La description personnalisée de l'écouteur. La 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
ListenerId	string	L'identifiant de l'écouteur.	lsn-3kbj3587mqhm3p****
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.	Provisioning
LoadBalancerId	string	L'identifiant de l'instance Gateway Load Balancer.	gwlb-te609d6696632f76****
RegionId	string	L'identifiant de la région où l'instance Gateway Load Balancer est déployée.	cn-hangzhou
RequestId	string	L'identifiant de la requête.	75CC3312-7757-5EE1-90D8-49CEA66608AE
ServerGroupId	string	L'identifiant du groupe de serveurs.	sgp-sp8d2r6y7t0xtl****
TcpIdleTimeout	integer	Le délai d'expiration d'une connexion TCP inactive.	350
Tags	array<object>	La liste des balises.
	object	La balise.
Key	string	La clé de la balise. La clé de la balise ne peut pas être une chaîne vide. La clé de la balise peut comporter jusqu'à 128 caractères, ne peut pas commencer par `aliyun` ou `acs:`, et ne peut pas contenir `http://` ou `https://`.	testKey
Value	string	La valeur de la balise. La valeur de la balise peut comporter jusqu'à 256 caractères et ne peut pas contenir `http://` ou `https://`.	testValue

Exemples

JSON format

{
  "ListenerDescription": "listener_description",
  "ListenerId": "lsn-3kbj3587mqhm3p****",
  "ListenerStatus": "Provisioning",
  "LoadBalancerId": "gwlb-te609d6696632f76****",
  "RegionId": "cn-hangzhou",
  "RequestId": "75CC3312-7757-5EE1-90D8-49CEA66608AE",
  "ServerGroupId": "sgp-sp8d2r6y7t0xtl****",
  "TcpIdleTimeout": 350,
  "Tags": [
    {
      "Key": "testKey",
      "Value": "testValue"
    }
  ]
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
404	ResourceNotFound.Listener	The specified resource of %s is not found.	The specified resource of %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.