DescribeLoadBalancerTCPListenerAttribute - - Centre de documentation Alibaba Cloud

Consulte la configuration d'un écouteur TCP.

Description de l'opération

Avant d'appeler cette opération, assurez-vous qu'un écouteur TCP a été créé sur le port spécifié de l'instance SLB cible en appelant CreateLoadBalancerTCPListener.

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.

slb:DescribeLoadBalancerTCPListenerAttribute

get

*loadbalancer.

acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

slb:tag
slb:tag
slb:tag
slb:tag
slb:tag

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Non	L'identifiant de la région de l'instance SLB. Vous pouvez obtenir l'identifiant de la région à partir de la liste Régions et zones ou en appelant l'opération DescribeRegions.	cn-hangzhou
LoadBalancerId	string	Oui	L'identifiant de l'instance SLB.	lb-bp1ygod3yctvg1y****
ListenerPort	integer	Oui	Le port frontal utilisé par l'instance SLB. Valeurs valides : 1 à 65535.	80

Éléments de réponse

Élément	Type	Description	Exemple
	object
VServerGroupId	string	L'identifiant du groupe vServer associé.	rsp-cige6******8
Status	string	L'état de l'écouteur. Valeurs valides : running : l'écouteur est en cours d'exécution. stopped : l'écouteur est arrêté.	stopped
AclType	string	Le type de contrôle d'accès. Valeurs valides : white : seules les requêtes provenant des adresses IP ou des blocs CIDR dans les paramètres du groupe de stratégies de contrôle d'accès spécifié sont transmises. Une liste blanche convient aux scénarios où seules des adresses IP spécifiques sont autorisées à accéder à une application. La configuration d'une liste blanche présente des risques opérationnels. Une fois la liste blanche configurée, seules les adresses IP de la liste blanche peuvent accéder à l'écouteur Server Load Balancer. 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 Server Load Balancer transmet toutes les requêtes. black : aucune requête provenant des adresses IP ou des blocs CIDR dans les paramètres du groupe de stratégies de contrôle d'accès spécifié n'est transmise. Une liste noire convient aux scénarios où des adresses IP spécifiques sont bloquées pour l'accès à une application. 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 Server Load Balancer transmet toutes les requêtes. Remarque Ce paramètre est requis lorsque le paramètre AclStatus est défini sur on.	white
ConnectionDrainTimeout	integer	Le délai d'attente pour la vidange des connexions. Ce paramètre est renvoyé lorsque le paramètre ConnectionDrain est défini sur on. Valeurs valides : 10 à 900. Unité : secondes.	300
RequestId	string	L'identifiant de la requête.	365F4154-92F6-4AE4-92F8-7FF34B540710
HealthCheckConnectPort	integer	Le port utilisé pour les vérifications de l'état de santé. Valeurs valides : 1 à 65535. Si les paramètres de ce paramètre ne sont pas spécifiés, le port de service backend (BackendServerPort) est utilisé.	8080
Description	string	Le nom personnalisé de l'écouteur.	TCP_80
Bandwidth	integer	La bande passante maximale de l'écouteur. Unité : Mbit/s. Valeurs valides : -1 : pour une instance SLB orientée Internet qui utilise la facturation au trafic, vous pouvez configurer les paramètres de la bande passante maximale sur -1, ce qui indique que la bande passante maximale n'est pas limitée. 1 à 5120 : pour une instance SLB orientée Internet qui utilise la facturation à la bande passante, vous pouvez configurer les paramètres de la bande passante maximale de chaque écouteur. Cependant, la somme des valeurs de bande passante maximale de tous les écouteurs ne peut pas dépasser la bande passante maximale de l'instance.	-1
HealthCheckType	string	La méthode de vérification de l'état de santé pour l'écouteur TCP. Valeurs valides : tcp et http.	tcp
MasterSlaveServerGroupId	string	L'identifiant du groupe de serveurs principal/secondaire associé.	rsp-0bfucw****
BackendServerPort	integer	Le port backend utilisé par l'instance SLB. Remarque Ce paramètre n'est pas affiché lorsque le groupe de serveurs backend est un groupe vServer.	443
AclStatus	string	Indique si le contrôle d'accès est activé. Valeurs valides : on : activé. off : désactivé.	off
HealthCheckDomain	string	Le nom de domaine utilisé pour les vérifications de l'état de santé. Valeurs valides : $_ip : l'adresse IP privée du serveur backend. Si une adresse IP est spécifiée ou si ce paramètre n'est pas spécifié, Server Load Balancer utilise l'adresse IP privée des serveurs backend comme noms de domaine pour les vérifications de l'état de santé. domain : le nom de domaine doit comporter de 1 à 80 caractères et ne peut contenir que des lettres, des chiffres, des points (.) et des traits d'union (-).	www.domain.com
UnhealthyThreshold	integer	Le seuil d'échec. Le nombre d'échecs consécutifs de vérification de l'état de santé requis avant que l'état de vérification de l'état de santé d'un serveur backend ne passe de success à failure. Valeurs valides : 2 à 10.	4
HealthCheckHttpCode	string	Le code d'état HTTP qui indique une vérification de l'état de santé réussie.	http_2xx
ProxyProtocolV2Enabled	boolean	Indique si le Proxy Protocol est utilisé pour transmettre l'adresse IP source du client au serveur backend. Valeurs valides : true : oui. false : non.	false
PersistenceTimeout	integer	Le délai d'attente pour la persistance de session. Valeurs valides : 0 à 3600. Unité : secondes. Valeur par défaut : 0, ce qui indique que la persistance de session est désactivée.	0
ListenerPort	integer	Le port frontal utilisé par l'instance SLB.	110
HealthCheckInterval	integer	L'intervalle entre deux vérifications consécutives de l'état de santé. Valeurs valides : 1 à 50. Unité : secondes.	5
HealthCheckURI	string	L'URL utilisée pour les vérifications de l'état de santé. L'URL doit comporter de 1 à 80 caractères et ne peut contenir que des lettres, des chiffres, des traits d'union (-), des barres obliques (/), des points (.), des signes de pourcentage (%), des points d'interrogation (?), des croisillons (#) et des esperluettes (&). L'URL ne peut pas être uniquement une barre oblique (/) mais doit commencer par une barre oblique (/).	/test/index.html
AclId	string	L'identifiant de la liste de contrôle d'accès (ACL) associée à l'écouteur. Ce paramètre est requis lorsque le paramètre AclStatus est défini sur on.	acl-uf60jwfi******
SynProxy	string	Indique si la fonctionnalité de prévention des attaques par proxy SYN de Server Load Balancer est activée. Nous vous recommandons de ne pas modifier ce paramètre sauf si nécessaire. Laissez Server Load Balancer gérer ce paramètre. Valeurs valides : enable : activé. disable : désactivé.	disable
Scheduler	string	L'algorithme de planification. Valeurs valides : wrr (par défaut) : les serveurs backend avec des poids plus élevés ont une fréquence d'interrogation plus élevée que ceux avec des poids plus faibles. rr : les requêtes sont réparties de manière égale et séquentielle sur les serveurs backend dans l'ordre d'accès. sch : hachage cohérent basé sur les adresses IP source. Les requêtes provenant de la même adresse IP source sont réparties sur le même serveur backend. tch : hachage cohérent basé sur quatre tuples (adresse IP source, adresse IP de destination, port source et port de destination). Les requêtes provenant du même flux sont réparties sur le même serveur backend. Remarque Seules les instances hautes performances prennent en charge les algorithmes de hachage cohérent sch et tch.	wrr
EstablishedTimeout	integer	Le délai d'attente de connexion.	500
HealthCheckConnectTimeout	integer	Le délai d'attente de la vérification de l'état de santé.	100
HealthyThreshold	integer	Le seuil de réussite. Le nombre de réussites consécutives de vérification de l'état de santé requis avant que l'état de vérification de l'état de santé d'un serveur backend ne passe de failure à success. Valeurs valides : 2 à 10.	4
ConnectionDrain	string	Indique si la vidange des connexions est activée. Ce paramètre est renvoyé lorsque le paramètre ConnectionDrain est défini sur on. Valeurs valides : on : activé. off : désactivé.	off
HealthCheckMethod	string	La méthode de vérification de l'état de santé.	tcp
HealthCheck	string	Indique si les vérifications de l'état de santé sont activées. Valeurs valides : on : activé. off : désactivé.	on
AclIds	object
AclId	array	La liste des identifiants des groupes de stratégies de contrôle d'accès.

LoadBalancerId	string	L'identifiant de l'instance SLB.	lb-bp1ygod3yctvg1y****
Tags	object
Tag	array<object>	La liste des balises.
	object	La liste des balises.
TagKey	string	La clé de balise de l'écouteur. Valeurs valides de N : 1 à 20. Si ce paramètre est spécifié, il ne peut pas s'agir d'une chaîne 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
TagValue	string	La valeur de balise de l'écouteur. Valeurs valides de N : 1 à 20. Si ce paramètre est spécifié, il peut s'agir d'une chaîne vide. La valeur de balise peut comporter jusqu'à 128 caractères et ne peut pas commencer par `acs:`. Elle ne peut pas contenir `http://` ou `https://`.	TestValue

Exemples

JSON format

{
  "VServerGroupId": "rsp-cige6******8",
  "Status": "stopped",
  "AclType": "white",
  "ConnectionDrainTimeout": 300,
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "HealthCheckConnectPort": 8080,
  "Description": "TCP_80",
  "Bandwidth": -1,
  "HealthCheckType": "tcp",
  "MasterSlaveServerGroupId": "rsp-0bfucw****",
  "BackendServerPort": 443,
  "AclStatus": "off",
  "HealthCheckDomain": "www.domain.com",
  "UnhealthyThreshold": 4,
  "HealthCheckHttpCode": "http_2xx",
  "ProxyProtocolV2Enabled": false,
  "PersistenceTimeout": 0,
  "ListenerPort": 110,
  "HealthCheckInterval": 5,
  "HealthCheckURI": "/test/index.html",
  "AclId": "acl-uf60jwfi******",
  "SynProxy": "disable",
  "Scheduler": "wrr",
  "EstablishedTimeout": 500,
  "HealthCheckConnectTimeout": 100,
  "HealthyThreshold": 4,
  "ConnectionDrain": "off",
  "HealthCheckMethod": "tcp",
  "HealthCheck": "on",
  "AclIds": {
    "AclId": [
      ""
    ]
  },
  "LoadBalancerId": "lb-bp1ygod3yctvg1y****",
  "Tags": {
    "Tag": [
      {
        "TagKey": "TestKey",
        "TagValue": "TestValue"
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	LocationServiceTimeout	Location service connection timeout. Please try again later.
403	UnauthorizedRegion	The specified region of is not authorized.	La région spécifiée n'est pas visible.

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

Notes de version

Consultez Notes de version pour la liste complète.