DescribeLoadBalancerUDPListenerAttribute - - Centre de documentation Alibaba Cloud

Consulte la configuration d'un écouteur UDP.

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

get

*loadbalancer.

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

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.	cn-hangzhou
LoadBalancerId	string	Oui	L'identifiant de l'instance Classic Load Balancer (CLB).	lb-bp1rtfnodmywb43e*****
ListenerPort	integer	Oui	Le port frontal utilisé par l'instance Classic Load Balancer (CLB). 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-cige6j****
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 configurés dans le groupe de stratégies de contrôle d'accès sélectionné sont transmises. Les listes blanches s'appliquent aux scénarios dans lesquels vous souhaitez autoriser uniquement des adresses IP spécifiques à accéder à votre application. L'activation d'une liste blanche présente des risques pour vos services. Après avoir activé une liste blanche, seules les adresses IP de la liste blanche peuvent accéder à l'écouteur SLB. 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 SLB transmet toutes les requêtes. black : toutes les requêtes provenant des adresses IP ou des blocs CIDR configurés dans le groupe de stratégies de contrôle d'accès sélectionné ne sont pas transmises. Les listes noires s'appliquent aux scénarios dans lesquels vous souhaitez refuser l'accès à votre application depuis des 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 SLB transmet toutes les requêtes.	white
RequestId	string	L'identifiant de la requête.	365F4154-92F6-4AE4-92F8-7FF34B540710
HealthCheckConnectPort	integer	Le port utilisé pour les bilans de santé. Valeurs valides : 1 à 65535. Si ce paramètre n'est pas défini, le port du service backend (BackendServerPort) est utilisé. Remarque Ce paramètre prend effet uniquement lorsque HealthCheck est défini sur on.	8080
Description	string	Le nom personnalisé de l'écouteur.	UDP_80
Bandwidth	integer	La bande passante maximale de l'écouteur. Unité : Mbit/s. Valeurs valides : -1 : pour une instance Server Load Balancer orientée Internet facturée au trafic, vous pouvez définir la bande passante maximale sur -1, ce qui indique que la bande passante maximale n'est pas limitée. 1 à 5120 : pour une instance Server Load Balancer orientée Internet facturée à la bande passante, vous pouvez définir la bande passante maximale pour 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
MasterSlaveServerGroupId	string	L'identifiant du groupe de serveurs principal/secondaire associé.	rsp-0bfucw****
BackendServerPort	integer	Le port backend utilisé par l'instance Classic Load Balancer (CLB). Remarque Ce paramètre n'est pas renvoyé si le groupe de serveurs backend est un groupe vServer.	90
AclStatus	string	Indique si le contrôle d'accès est activé. Valeurs valides : on ou off (par défaut).	off
UnhealthyThreshold	integer	Le seuil d'échec. Le nombre d'échecs consécutifs du bilan de santé avant qu'un serveur backend ne soit déclaré comme défaillant, ce qui signifie que l'état du bilan de santé passe de success à fail. Valeurs valides : 2 à 10.	4
ProxyProtocolV2Enabled	boolean	Indique si le Proxy Protocol est utilisé pour transmettre les adresses source des clients aux serveurs backend. Valeurs valides : true : le Proxy Protocol est utilisé. false : le Proxy Protocol n'est pas utilisé.	false
ListenerPort	integer	Le port frontal utilisé par l'instance Classic Load Balancer (CLB).	53
HealthCheckInterval	integer	L'intervalle entre deux bilans de santé consécutifs. Valeurs valides : 1 à 50. Unité : secondes.	5
HealthCheckExp	string	La chaîne de réponse pour les bilans de santé de l'écouteur UDP. La chaîne ne peut contenir que des lettres et des chiffres et sa longueur peut atteindre 64 caractères.	ok
AclId	string	L'identifiant du groupe de stratégies de contrôle d'accès.	acl-uf60jwfiv6******
Scheduler	string	L'algorithme de planification. Valeurs valides : wrr (par défaut) : les serveurs backend avec des poids plus élevés reçoivent plus de requêtes que les serveurs backend avec des poids plus faibles. rr : les requêtes sont distribuées aux serveurs backend de manière séquentielle.	wrr
HealthCheckConnectTimeout	integer	Le délai d'attente maximal pour une réponse au bilan de santé. Si une instance ECS backend ne répond pas dans le délai imparti, le bilan de santé échoue. Valeurs valides : 1 à 300. Unité : secondes.	100
HealthyThreshold	integer	Le seuil de réussite. Le nombre de bilans de santé réussis consécutifs avant qu'un serveur backend ne soit déclaré comme sain, ce qui signifie que l'état du bilan de santé passe de fail à success. Valeurs valides : 2 à 10.	4
HealthCheckReq	string	La chaîne de requête pour les bilans de santé de l'écouteur UDP. La chaîne ne peut contenir que des lettres et des chiffres et sa longueur peut atteindre 64 caractères.	hello
HealthCheck	string	Indique si les bilans de santé sont activés. Valeurs valides : on : les bilans de santé sont activés. off : les bilans de santé sont désactivés.	on
AclIds	object
AclId	array	L'identifiant du groupe de stratégies de contrôle d'accès.

LoadBalancerId	string	L'identifiant de l'instance Classic Load Balancer (CLB).	lb-bp1rtfnodmywb43e*****
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. 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://`.	TestKey
TagValue	string	La valeur de balise de l'écouteur. Valeurs valides de N : 1 à 20. La valeur de balise peut être une chaîne vide. La valeur de balise peut comporter jusqu'à 128 caractères et ne peut pas commencer par `acs:`. La valeur de balise ne peut pas contenir `http://` ou `https://`.	TestValue

Exemples

JSON format

{
  "VServerGroupId": "rsp-cige6j****",
  "Status": "stopped",
  "AclType": "white",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "HealthCheckConnectPort": 8080,
  "Description": "UDP_80",
  "Bandwidth": -1,
  "MasterSlaveServerGroupId": "rsp-0bfucw****",
  "BackendServerPort": 90,
  "AclStatus": "off",
  "UnhealthyThreshold": 4,
  "ProxyProtocolV2Enabled": false,
  "ListenerPort": 53,
  "HealthCheckInterval": 5,
  "HealthCheckExp": "ok",
  "AclId": "acl-uf60jwfiv6******",
  "Scheduler": "wrr",
  "HealthCheckConnectTimeout": 100,
  "HealthyThreshold": 4,
  "HealthCheckReq": "hello",
  "HealthCheck": "on",
  "AclIds": {
    "AclId": [
      ""
    ]
  },
  "LoadBalancerId": "lb-bp1rtfnodmywb43e*****",
  "Tags": {
    "Tag": [
      {
        "TagKey": "TestKey",
        "TagValue": "TestValue"
      }
    ]
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.