ListServerGroups - - Centre de documentation Alibaba Cloud

Consulte la liste des groupes de serveurs d'une instance d'équilibrage de charge Network Load Balancer (NLB).

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.

nlb:ListServerGroups

get

ServerGroup

acs:nlb:{#regionId}:{#accountId}:servergroup/*

ServerGroup

acs:nlb:{#regionId}:{#accountId}:servergroup/{#ServerGroupId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
ServerGroupIds	array	Non	Les identifiants des groupes de serveurs. Vous pouvez interroger jusqu'à 20 identifiants de groupes de serveurs à la fois.
	string	Non	Les identifiants des groupes de serveurs. Vous pouvez interroger jusqu'à 20 identifiants de groupes de serveurs à la fois.	sgp-atstuj3rtoptyui****
ServerGroupNames	array	Non	Les noms des groupes de serveurs. Vous pouvez interroger jusqu'à 20 noms de groupes de serveurs à la fois.
	string	Non	Les noms des groupes de serveurs. Vous pouvez interroger jusqu'à 20 noms de groupes de serveurs à la fois.	NLB_ServerGroup
ResourceGroupId	string	Non	L'identifiant du groupe de ressources auquel le groupe de serveurs appartient.	rg-atstuj3rtop****
ServerGroupType	string	Non	Le type du groupe de serveurs. Valeurs valides : Instance : type de serveur. Ce type de groupe de serveurs prend en charge l'ajout d'instances Ecs, Ens et Eci. Ip : type d'adresse IP. Ce type de groupe de serveurs prend en charge l'ajout direct d'adresses IP.	Instance
VpcId	string	Non	L'identifiant du VPC auquel le groupe de serveurs appartient.	vpc-bp15zckdt37pq72zv****
Tag	array<object>	Non	Les balises.
	object	Non	Les balises.
Key	string	Non	La clé de balise. Vous pouvez spécifier jusqu'à 10 clés de balise. La clé de balise peut comporter jusqu'à 64 caractères et ne peut pas commencer par aliyun ou acs:. Elle ne peut pas contenir http:// ou https://.	Test
Value	string	Non	La valeur de la balise. Vous pouvez spécifier jusqu'à 10 valeurs de balise. La valeur de la balise peut comporter jusqu'à 128 caractères et ne peut pas commencer par `aliyun` ou `acs:`. Elle ne peut pas contenir `http://` ou `https://`.	Test
NextToken	string	Non	Le jeton de pagination utilisé dans la requête suivante pour récupérer une nouvelle page de résultats. Valeurs valides : Il n'est pas nécessaire de spécifier ce paramètre pour la première requête ou si aucune requête suivante n'existe. Si une requête suivante existe, définissez la valeur sur la valeur NextToken renvoyée lors de l'appel d'API précédent.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	Non	Le nombre d'entrées par page. Valeurs valides : 1 à 100. Valeur par défaut : 20.	20
RegionId	string	Non	L'identifiant de la région de l'instance d'équilibrage de charge Network Load Balancer (NLB). Vous pouvez appeler l'opération DescribeRegions pour obtenir l'identifiant de la région.	cn-hangzhou

Éléments de réponse

Élément	Type	Description	Exemple
	object	La réponse pour l'interrogation des groupes de serveurs.
RequestId	string	L'identifiant de la requête.	54B28E3D-DF70-471B-AA93-08E683A1B45
ServerGroups	array<object>	La liste des groupes de serveurs back-end.
	array<object>	La liste des groupes de serveurs back-end.
RegionId	string	L'identifiant de la région de l'instance d'équilibrage de charge Network Load Balancer (NLB).	cn-hangzhou
ServerGroupId	string	L'identifiant du groupe de serveurs.	sgp-atstuj3rtoptyui****
ServerGroupName	string	Le nom du groupe de serveurs.	NLB_ServerGroup
ServerGroupType	string	Le type du groupe de serveurs. Valeurs valides : Instance : type de serveur. Ce type de groupe de serveurs prend en charge l'ajout d'instances Ecs, Ens et Eci. Ip : type d'adresse IP. Ce type de groupe de serveurs prend en charge l'ajout direct d'adresses IP.	Instance
AddressIPVersion	string	La version du protocole. Valeurs valides : Ipv4 : type IPv4. DualStack : type double pile.	ipv4
VpcId	string	L'identifiant du VPC auquel le groupe de serveurs appartient.	vpc-bp15zckdt37pq72zv****
Scheduler	string	L'algorithme de répartition. Valeurs valides : Wrr : round-robin pondéré. Les serveurs backend ayant les poids les plus élevés sont sollicités plus fréquemment. Wlc : moindre nombre de connexions pondéré. Outre la répartition basée sur le poids configuré pour chaque serveur backend, la charge réelle (nombre de connexions) du serveur backend est également prise en compte. À poids égal, les serveurs backend ayant le moins de connexions actives sont sollicités plus fréquemment. rr : round-robin. Les requêtes sont distribuées aux serveurs backend dans l'ordre d'accès. sch : hachage d'IP source. Les requêtes provenant de la même adresse source sont acheminées vers le même serveur backend. tch : hachage à quatre éléments. Hachage cohérent basé sur quatre éléments (adresse IP source, adresse IP de destination, port source et port de destination). Les requêtes provenant du même flux sont acheminées vers le même serveur backend. qch : hachage d'ID QUIC. Les requêtes ayant le même ID QUIC sont acheminées vers le même serveur backend.	Wrr
Protocol	string	Le protocole de transfert back-end. Valeurs valides : TCP et UDP.	TCP
HealthCheck	object	La configuration du contrôle d'état.
HealthCheckEnabled	boolean	Indicates whether health check is enabled. Valid values: true: Enabled. false: Disabled.	false
HealthCheckType	string	The health check protocol. Valid values: TCP HTTP UDP	TCP
HealthCheckConnectPort	integer	The port of the backend server used for health checks. Valid values: 0 to 65535. A value of 0 indicates that the port of the backend server is used for health checks.	200
HealthyThreshold	integer	The number of consecutive successful health checks required before a backend server is declared healthy (status changes from fail to success). Valid values: 2 to 10.	2
UnhealthyThreshold	integer	The number of consecutive failed health checks required before a backend server is declared unhealthy (status changes from success to fail). Valid values: 2 to 10.	3
HealthCheckConnectTimeout	integer	The maximum timeout period for a health check response. Unit: seconds. Default value: 5. Valid values: 1 to 300.	200
HealthCheckInterval	integer	The interval between two consecutive health checks. Unit: seconds. Default value: 5. If HealthCheckType is set to TCP or HTTP, valid values are 1 to 50. If HealthCheckType is set to UDP, valid values are 1 to 300. Set the interval to a value greater than or equal to the response timeout period to prevent UDP probe responses from being incorrectly identified as non-responses due to timeout.	10
HealthCheckDomain	string	The domain name used for health checks. Valid values: $SERVER_IP: the private IP address of the backend server. domain: a specific domain name. The domain name can be 1 to 80 characters in length and can contain only lowercase letters, digits, hyphens (-), and periods (.). Remarque This parameter takes effect only when HealthCheckType is set to HTTP.	$SERVER_IP
HealthCheckUrl	string	The health check path. Remarque This parameter takes effect only when HealthCheckType is set to HTTP.	/test/index.html
HealthCheckHttpCode	array	The HTTP status codes for a healthy response. Multiple status codes are separated by commas (,). Valid values: http_2xx, http_3xx, http_4xx, and http_5xx. Remarque This parameter takes effect only when HealthCheckType is set to HTTP.
	string	The HTTP status codes for a healthy response. Multiple status codes are separated by commas (,). Valid values: http_2xx, http_3xx, http_4xx, and http_5xx. Remarque This parameter takes effect only when HealthCheckType is set to HTTP.	http_2xx
HttpCheckMethod	string	The health check method. Valid values: GET and HEAD. Remarque This parameter takes effect only when HealthCheckType is set to HTTP.	GET
HealthCheckReq	string	The request string for UDP listener health checks. The string can contain only letters and digits and can be up to 512 characters in length.	hello
HealthCheckExp	string	The response string for UDP listener health checks. The string can contain only letters and digits and can be up to 512 characters in length.	ok
HealthCheckHttpVersion	string	The HTTP version for health checks. Valid values: HTTP1.0 and HTTP1.1. Remarque This parameter takes effect only when HealthCheckType is set to HTTP.	HTTP1.0
ConnectionDrainEnabled	boolean	Indique si le drainage des connexions est activé. Valeurs valides : true : Activé. false : Désactivé.	false
ConnectionDrainTimeout	integer	Le délai de vidange des connexions. Unité : secondes. Valeurs valides : 10 à 900.	200
PreserveClientIpEnabled	boolean	Indique si la préservation de l'adresse IP client est activée. Valeurs valides : true : Activé. false : Désactivé. Remarque Lorsque AddressIPVersion est défini sur ipv4, la valeur par défaut est true. Lorsque AddressIPVersion est défini sur ipv6, la valeur ne peut être que false. Cette valeur passera à true une fois que l'infrastructure sous-jacente le prendra en charge.	true
AnyPortEnabled	boolean	Indique si le transfert de tous les ports est activé. Valeurs valides : true : Activé. false : Désactivé.	false
ResourceGroupId	string	L'identifiant du groupe de ressources auquel le groupe de serveurs appartient.	rg-atstuj3rtop****
ServerGroupStatus	string	L'état du groupe de serveurs. Valeurs valides : Creating : Le groupe de serveurs est en cours de création. Available : Le groupe de serveurs est disponible. Configuring : Le groupe de serveurs est en cours de modification.	Available
AliUid	integer	L'UID de l'utilisateur.	165820696622****
Tags	array<object>	Les balises.
	object	Les balises.
Key	string	The tag key. You can specify up to 10 tag keys. The tag key can be up to 64 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	Test
Value	string	The tag value. You can specify up to 10 tag values. The tag value can be up to 128 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	Test
RelatedLoadBalancerIds	array	La liste des instances d'équilibreur de charge Network Load Balancer (NLB).
	string	La liste des instances d'équilibreur de charge Network Load Balancer (NLB).	nlb-83ckzc8d4xlp8o****
ServerCount	integer	Le nombre de serveurs backend.	2
IpVersionAffinityMode	string	La stratégie de répartition du trafic en mode double pile : NonAffinity (par défaut) : mode sans affinité. Le trafic est transféré vers les backends sains en fonction de l'algorithme de répartition, quelle que soit la version du protocole IP de la source. Affinity : mode avec affinité. Le trafic est transféré en fonction de la version du protocole IP de la source de la requête. Les requêtes IPv4 sont transférées uniquement vers les backends IPv4, et les requêtes IPv6 sont transférées uniquement vers les backends IPv6. Remarque Ce paramètre prend effet uniquement lorsque AddressIPVersion est défini sur DualStack.	Affinity
TotalCount	integer	Le nombre total d'entrées retournées.	1
NextToken	string	Le jeton de pagination utilisé dans la requête suivante pour récupérer une nouvelle page de résultats. Valeurs valides :\n- Si NextToken est vide, il n'y a pas de requête suivante.\n- Si NextToken est renvoyé, la valeur indique le jeton pour la requête suivante.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	Le nombre d'entrées par page. Valeurs valides : 1 à 100.	20

Exemples

JSON format

{
  "RequestId": "54B28E3D-DF70-471B-AA93-08E683A1B45",
  "ServerGroups": [
    {
      "RegionId": "cn-hangzhou",
      "ServerGroupId": "sgp-atstuj3rtoptyui****",
      "ServerGroupName": "NLB_ServerGroup",
      "ServerGroupType": "Instance",
      "AddressIPVersion": "ipv4",
      "VpcId": "vpc-bp15zckdt37pq72zv****",
      "Scheduler": "Wrr",
      "Protocol": "TCP",
      "HealthCheck": {
        "HealthCheckEnabled": false,
        "HealthCheckType": "TCP",
        "HealthCheckConnectPort": 200,
        "HealthyThreshold": 2,
        "UnhealthyThreshold": 3,
        "HealthCheckConnectTimeout": 200,
        "HealthCheckInterval": 10,
        "HealthCheckDomain": "$SERVER_IP",
        "HealthCheckUrl": "/test/index.html",
        "HealthCheckHttpCode": [
          "http_2xx"
        ],
        "HttpCheckMethod": "GET",
        "HealthCheckReq": "hello",
        "HealthCheckExp": "ok",
        "HealthCheckHttpVersion": "HTTP1.0"
      },
      "ConnectionDrainEnabled": false,
      "ConnectionDrainTimeout": 200,
      "PreserveClientIpEnabled": true,
      "AnyPortEnabled": false,
      "ResourceGroupId": "rg-atstuj3rtop****",
      "ServerGroupStatus": "Available",
      "AliUid": 0,
      "Tags": [
        {
          "Key": "Test",
          "Value": "Test"
        }
      ],
      "RelatedLoadBalancerIds": [
        "nlb-83ckzc8d4xlp8o****"
      ],
      "ServerCount": 2,
      "IpVersionAffinityMode": "Affinity"
    }
  ],
  "TotalCount": 1,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults": 20
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	SystemBusy	System is busy, please try again later.
403	Forbidden.%s	Authentication is failed for %s.
403	Forbidden.NoPermission	Authentication is failed for NoPermission.	Authentication is failed for NoPermission.

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

Notes de version

Consultez Notes de version pour la liste complète.