DescribeListener - - Centre de documentation Alibaba Cloud

Consulte la configuration d'un écouteur spécifié en appelant l'opération DescribeListener.

Description de l'opération

Consulte la configuration d'un écouteur spécifié, y compris le type de routage, l'état, l'horodatage de création et les informations de port de l'écouteur.

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.

ga:DescribeListener

get

*Listener

acs:ga:{#regionId}:{#accountId}:listener/{#listenerId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région de l'instance Alibaba Cloud Global Accelerator (GA). Définissez la valeur sur cn-hangzhou.	cn-hangzhou
ListenerId	string	Oui	L'identifiant de l'écouteur à interroger.	lsr-bp1bpn0kn908w4nbw****

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
Description	string	La description de l'écouteur.	Listener
RequestId	string	L'identifiant de la requête.	6FEA0CF3-D3B9-43E5-A304-D217037876A8
State	string	L'état de l'écouteur. configuring : l'écouteur est en cours de configuration. init : l'écouteur est en cours d'initialisation. updating : l'écouteur est en cours de mise à jour. deleting : l'écouteur est en cours de suppression.	active
CreateTime	string	L'horodatage de la création de l'écouteur. Unité : millisecondes.	1577786252000
PortRanges	array<object>	Les informations de port de l'écouteur.
	object	Les informations de port de l'écouteur.
FromPort	integer	Le premier port d'écoute de la plage de ports utilisée pour recevoir les requêtes et les transférer vers les points de terminaison.	20
ToPort	integer	Le dernier port d'écoute de la plage de ports utilisée pour recevoir les requêtes et les transférer vers les points de terminaison.	20
BackendPorts	array<object>	Les informations de port back-end.
	object	La plage de ports back-end.
FromPort	string	Le premier port de la plage de ports utilisée par le serveur back-end pour accepter les requêtes. Ce paramètre n'est renvoyé que lorsque le protocole de l'écouteur est HTTPS et que le port d'écoute est identique au port sur lequel le service back-end est fourni.	80
ToPort	string	Le dernier port de la plage de ports utilisée par le serveur back-end pour accepter les requêtes.	80
Certificates	array<object>	La liste des certificats SSL.
	object	La liste des certificats SSL.
Type	string	Le type de certificat. Actuellement, seul Server (certificat de serveur) est pris en charge.	Server
Id	string	L'identifiant du certificat SSL.	449****-cn-hangzhou
Protocol	string	Le type de protocole de transmission réseau de l'écouteur. TCP : protocole TCP. UDP : protocole UDP. HTTP : protocole HTTP. HTTPS : protocole HTTPS.	TCP
ListenerId	string	L'identifiant de l'écouteur.	lsr-bp1bpn0kn908w4nbw****
ClientAffinity	string	L'affinité client. Si NONE est renvoyé, l'affinité client n'est pas maintenue. Les connexions provenant du même client ne sont pas toujours dirigées vers le même point de terminaison. Si SOURCE_IP est renvoyé, l'affinité client est maintenue. Lorsqu'un client accède à une application avec état, toutes les requêtes provenant du même client peuvent être dirigées vers le même point de terminaison, quels que soient le port source et le protocole.	SOURCE_IP
Name	string	Le nom de l'écouteur.	Listener
RelatedAcls	array<object>	Les informations sur le groupe de stratégies de contrôle d'accès associé à l'écouteur.
	object	Les informations sur le groupe de stratégies de contrôle d'accès associé à l'écouteur.
AclId	string	L'identifiant du groupe de stratégies de contrôle d'accès associé à l'écouteur.	123
Status	string	Indique si la fonctionnalité de contrôle d'accès est activée. Associated : activée.	Associated
AclType	string	Le type de contrôle d'accès : white : seules les requêtes provenant des adresses IP ou des blocs CIDR du groupe de stratégies de contrôle d'accès sélectionné sont transférées. Les listes blanches s'appliquent aux scénarios dans lesquels une application n'autorise l'accès qu'à partir d'adresses IP spécifiques. L'activation d'une liste blanche présente certains risques. Une fois la liste blanche activée, seules les adresses IP figurant dans la liste blanche peuvent accéder à l'écouteur Global Accelerator. Si une liste blanche est activée mais qu'aucune adresse IP n'est ajoutée au groupe de stratégies de contrôle d'accès, l'écouteur Global Accelerator ne transfère aucune requête. black : toutes les requêtes provenant des adresses IP ou des blocs CIDR du groupe de stratégies de contrôle d'accès sélectionné sont bloquées. Les listes noires s'appliquent aux scénarios dans lesquels une application refuse l'accès uniquement à partir d'adresses IP spécifiques. Si une liste noire est activée mais qu'aucune adresse IP n'est ajoutée au groupe de stratégies de contrôle d'accès, l'écouteur Global Accelerator transfère toutes les requêtes. Ce paramètre n'est renvoyé que lorsque la valeur du paramètre Status est on.	white
AcceleratorId	string	L'identifiant de l'instance Alibaba Cloud Global Accelerator (GA).	ga-bp1odcab8tmno0hdq****
ProxyProtocol `deprecated`	boolean	Indique si la fonctionnalité de préservation de l'adresse IP du client est activée. true : la fonctionnalité de préservation de l'adresse IP du client est activée. Une fois cette fonctionnalité activée, les services back-end peuvent consulter les adresses IP d'origine des clients. false : la fonctionnalité de préservation de l'adresse IP du client est désactivée.	false
XForwardedForConfig	object	Les informations de configuration du champ `XForward`.
XForwardedForGaIdEnabled	boolean	Indique si l'en-tête `GA-ID` est utilisé pour récupérer l'identifiant de l'instance Alibaba Cloud Global Accelerator (GA). true : oui. false : non. Remarque Seuls les écouteurs HTTP et HTTPS prennent en charge ce paramètre.	false
XForwardedForGaApEnabled	boolean	Indique si l'en-tête `GA-AP` est utilisé pour récupérer les informations de la zone d'accélération. true : oui. false : non. Remarque Seuls les écouteurs HTTP et HTTPS prennent en charge ce paramètre.	false
XForwardedForProtoEnabled	boolean	Indique si l'en-tête `GA-X-Forward-Proto` est utilisé pour récupérer le protocole de l'écouteur de l'instance Alibaba Cloud Global Accelerator (GA). true : oui. false : non. Remarque Seuls les écouteurs HTTP et HTTPS prennent en charge ce paramètre.	false
XForwardedForPortEnabled	boolean	Indique si l'en-tête `GA-X-Forward-Port` est utilisé pour récupérer le port de l'écouteur de l'instance Alibaba Cloud Global Accelerator (GA). true : oui. false : non. Remarque Seuls les écouteurs HTTP et HTTPS prennent en charge ce paramètre.	false
XRealIpEnabled	boolean	Indique si l'en-tête `X-Real-IP` est utilisé pour récupérer l'adresse IP réelle du client. true : oui. false : non. Remarque Seuls les écouteurs HTTP et HTTPS prennent en charge ce paramètre.	false
SecurityPolicyId	string	L'identifiant de l'instance de stratégie de sécurité TLS. tls_cipher_policy_1_0 Versions TLS prises en charge : TLSv1.0, TLSv1.1 et TLSv1.2. Suites d'algorithmes de chiffrement prises en charge : ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, AES128-GCM-SHA256, AES256-GCM-SHA384, AES128-SHA256, AES256-SHA256, ECDHE-RSA-AES128-SHA, ECDHE-RSA-AES256-SHA, AES128-SHA, AES256-SHA et DES-CBC3-SHA. tls_cipher_policy_1_1 Versions TLS prises en charge : TLSv1.1 et TLSv1.2. Suites d'algorithmes de chiffrement prises en charge : ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, AES128-GCM-SHA256, AES256-GCM-SHA384, AES128-SHA256, AES256-SHA256, ECDHE-RSA-AES128-SHA, ECDHE-RSA-AES256-SHA, AES128-SHA, AES256-SHA et DES-CBC3-SHA. tls_cipher_policy_1_2 Versions TLS prises en charge : TLSv1.2. Suites d'algorithmes de chiffrement prises en charge : ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, AES128-GCM-SHA256, AES256-GCM-SHA384, AES128-SHA256, AES256-SHA256, ECDHE-RSA-AES128-SHA, ECDHE-RSA-AES256-SHA, AES128-SHA, AES256-SHA et DES-CBC3-SHA. tls_cipher_policy_1_2_strict Versions TLS prises en charge : TLSv1.2. Suites d'algorithmes de chiffrement prises en charge : ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, ECDHE-RSA-AES128-SHA et ECDHE-RSA-AES256-SHA. tls_cipher_policy_1_2_strict_with_1_3 Versions TLS prises en charge : TLSv1.2 et TLSv1.3. Suites d'algorithmes de chiffrement prises en charge : TLS_AES_128_GCM_SHA256, TLS_AES_256_GCM_SHA384, TLS_CHACHA20_POLY1305_SHA256, TLS_AES_128_CCM_SHA256, TLS_AES_128_CCM_8_SHA256, ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES256-GCM-SHA384, ECDHE-ECDSA-AES128-SHA256, ECDHE-ECDSA-AES256-SHA384, ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, ECDHE-ECDSA-AES128-SHA, ECDHE-ECDSA-AES256-SHA, ECDHE-RSA-AES128-SHA et ECDHE-RSA-AES256-SHA. Remarque Seuls les écouteurs HTTPS prennent en charge ce paramètre.	tls_cipher_policy_1_0
Type	string	Le type de routage de l'écouteur. Standard : type de routage intelligent. CustomRouting : type de routage personnalisé.	Standard
ServiceId	string	L'identifiant du service qui gère l'instance gérée. Remarque Ce paramètre n'est valide que lorsque le paramètre ServiceManaged est défini sur True.	ALB
ServiceManaged	boolean	Indique si l'instance est gérée. Valeurs valides : true : l'instance est gérée. false : l'instance n'est pas gérée.	true
ServiceManagedInfos	array<object>	La liste des stratégies d'action que l'utilisateur peut exécuter sur l'instance gérée. Remarque Ce paramètre n'est valide que lorsque le paramètre ServiceManaged est défini sur True. Lorsque l'instance est à l'état géré, les opérations de l'utilisateur sur l'instance sont restreintes et certaines opérations sont interdites.
	object	La liste des stratégies d'action que l'utilisateur peut exécuter sur l'instance gérée.
Action	string	Le nom de l'action de stratégie gérée. Valeurs valides : Create : crée une instance. Update : met à jour l'instance actuelle. Delete : supprime l'instance actuelle. Associate : référence ou est référencé par l'instance actuelle. UserUnmanaged : retire la gestion de l'instance. CreateChild : crée une ressource enfant sous l'instance actuelle.	Update
ChildType	string	Le type de ressource enfant. Valeurs valides : Listener : ressource d'écouteur. IpSet : ressource de région d'accélération. EndpointGroup : ressource de groupe de points de terminaison. ForwardingRule : ressource de règle de transfert. Endpoint : ressource de point de terminaison. EndpointGroupDestination : ressource de mappage de protocole du groupe de points de terminaison sous un écouteur de routage personnalisé. EndpointPolicy : ressource de stratégie de trafic de point de terminaison sous un écouteur de routage personnalisé. Remarque Ce paramètre n'est valide que lorsque le paramètre Action est défini sur CreateChild.	Listener
IsManaged	boolean	Indique si l'action de stratégie gérée est gérée. Valeurs valides : true : l'action de stratégie gérée est gérée. L'utilisateur ne peut pas effectuer l'opération spécifiée par Action sur l'instance gérée. false : l'action de stratégie gérée n'est pas gérée. L'utilisateur peut effectuer l'opération spécifiée par Action sur l'instance gérée.	false
IdleTimeout	integer	Le délai d'expiration de la connexion inactive. Unité : secondes.	900
RequestTimeout	integer	Le délai d'expiration de la requête de connexion HTTP/HTTPS. Unité : secondes. Remarque Ce paramètre n'est valide que pour les écouteurs dont le Protocol (type de protocole de transmission réseau) est HTTP ou HTTPS. Si le serveur back-end ne renvoie pas de réponse dans le délai imparti, Global Accelerator cesse d'attendre et renvoie un code d'erreur HTTP 504 au client.	60
HttpVersion	string	La version maximale du protocole HTTP. Valeurs valides : http3 : HTTP/3. http2 : HTTP/2. http1.1 : HTTP/1.1. Remarque Seuls les écouteurs HTTPS prennent en charge ce paramètre.	http2

Exemples

JSON format

{
  "Description": "Listener",
  "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8",
  "State": "active",
  "CreateTime": "1577786252000",
  "PortRanges": [
    {
      "FromPort": 20,
      "ToPort": 20
    }
  ],
  "BackendPorts": [
    {
      "FromPort": "80",
      "ToPort": "80"
    }
  ],
  "Certificates": [
    {
      "Type": "Server",
      "Id": "449****-cn-hangzhou"
    }
  ],
  "Protocol": "TCP",
  "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
  "ClientAffinity": "SOURCE_IP",
  "Name": "Listener",
  "RelatedAcls": [
    {
      "AclId": "123",
      "Status": "Associated"
    }
  ],
  "AclType": "white",
  "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
  "ProxyProtocol": false,
  "XForwardedForConfig": {
    "XForwardedForGaIdEnabled": false,
    "XForwardedForGaApEnabled": false,
    "XForwardedForProtoEnabled": false,
    "XForwardedForPortEnabled": false,
    "XRealIpEnabled": false
  },
  "SecurityPolicyId": "tls_cipher_policy_1_0",
  "Type": "Standard",
  "ServiceId": "ALB",
  "ServiceManaged": true,
  "ServiceManagedInfos": [
    {
      "Action": "Update",
      "ChildType": "Listener",
      "IsManaged": false
    }
  ],
  "IdleTimeout": 900,
  "RequestTimeout": 60,
  "HttpVersion": "http2"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	NotExist.Listener	listener %s is not exist
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.

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

Notes de version

Consultez Notes de version pour la liste complète.