ListServerGroups - - Centre de documentation Alibaba Cloud

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	ListServerGroups	Opération à effectuer. Définissez la valeur sur ListServerGroups.
ServerGroupIds.N	String	No	sgp-atstuj3rtoptyui****	ID du groupe de serveurs. Vous pouvez spécifier jusqu'à 20 ID de groupes de serveurs par requête.
ServerGroupNames.N	String	No	NLB_ServerGroup	Noms des groupes de serveurs à interroger. Vous pouvez spécifier jusqu'à 20 noms par requête.
ResourceGroupId	String	No	rg-atstuj3rtop****	ID du groupe de ressources auquel appartient le groupe de serveurs.
ServerGroupType	String	No	Instance	Type de groupe de serveurs. Valeurs valides : Instance : permet d'ajouter des serveurs de types Ecs, Ens et Eci. Ip: permet d'ajouter des serveurs en spécifiant des adresses IP.
VpcId	String	No	vpc-bp15zckdt37pq72zv****	ID du VPC (Virtual Private Cloud) auquel appartient le groupe de serveurs.
Tag.N.Key	String	No	Test	Clé du tag. Vous pouvez spécifier jusqu'à 10 clés de tags. La clé du tag peut comporter jusqu'à 64 caractères et ne doit pas contenir `http://` ni `https://`. Elle ne doit pas commencer par `aliyun` ou `acs:`.
Tag.N.Value	String	No	Test	Valeur du tag. Vous pouvez spécifier jusqu'à 10 valeurs de tags. La valeur du tag peut comporter jusqu'à 128 caractères et ne doit pas contenir `http://` ni `https://`. Elle ne doit pas commencer par `aliyun` ou `acs:`.
NextToken	String	No	FFmyTO70tTpLG6I3FmYAXGKPd****	Jeton qui détermine le point de départ de la requête. Valeurs valides : S'il s'agit de votre première requête et qu'aucune requête suivante ne doit être envoyée, ignorez ce paramètre. Si une requête suivante doit être envoyée, définissez la valeur sur celle de NextToken renvoyée lors du dernier appel.
MaxResults	Integer	No	20	Nombre d'entrées à renvoyer par page. Valeurs valides : 1 à 100. Valeur par défaut : 20.
RegionId	String	No	cn-hangzhou	ID de la région où l'instance NLB est déployée. Vous pouvez appeler l'opération DescribeRegions pour interroger la liste des régions la plus récente.

Paramètres de réponse

Parameter	Type	Example	Description
RequestId	String	54B28E3D-DF70-471B-AA93-08E683A1B45	ID de la requête.
ServerGroups	Array of ServerGroup		Groupes de serveurs.
RegionId	String	cn-hangzhou	ID de la région où l'instance NLB est déployée.
ServerGroupId	String	sgp-atstuj3rtoptyui****	ID du groupe de serveurs.
ServerGroupName	String	NLB_ServerGroup	Nom du groupe de serveurs.
ServerGroupType	String	Instance	Type de groupe de serveurs. Valeurs valides : Instance : permet d'ajouter des serveurs de types Ecs, Ens et Eci. Ip: permet d'ajouter des serveurs en spécifiant des adresses IP.
AddressIPVersion	String	ipv4	Version du protocole. Valeurs valides : ipv4: IPv4 DualStack: pile double
VpcId	String	vpc-bp15zckdt37pq72zv****	ID du VPC auquel appartient le groupe de serveurs.
Scheduler	String	Wrr	Algorithme de planification. Valeurs valides : Wrr: 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 transférées aux serveurs backend séquentiellement. sch : Les requêtes sont transférées aux serveurs backend en fonction du hachage de l'adresse IP source. sch: Les requêtes provenant de la même adresse IP source sont transférées vers le même serveur backend. tch: Hachage à quatre éléments, qui spécifie un hachage cohérent basé sur quatre facteurs : adresse IP source, adresse IP de destination, port source et port de destination. Les requêtes contenant les mêmes informations basées sur ces quatre facteurs sont transférées vers le même serveur backend. qch: Hachage d'ID QUIC. Les requêtes contenant le même ID QUIC sont transférées vers le même serveur backend.
Protocol	String	TCP	Protocole utilisé pour transférer les requêtes aux serveurs backend. Valeurs valides : TCP, UDP et TCPSSL.
HealthCheck	Object		Configurations des vérifications d'état.
HealthCheckEnabled	Boolean	false	Indique si la fonction de vérification d'état est activée. Valeurs valides : true: activé false: désactivé
HealthCheckType	String	TCP	Protocole utilisé pour les vérifications d'état. Valeurs valides : TCP et HTTP.
HealthCheckConnectPort	Integer	200	Port backend utilisé pour les vérifications d'état. Valeurs valides : 0 à 65535. Une valeur de 0 indique que le port d'un serveur backend est utilisé pour les vérifications d'état.
HealthyThreshold	Integer	2	Nombre de fois qu'un serveur backend non sain doit réussir consécutivement les vérifications d'état avant d'être déclaré sain. Dans ce cas, l'état de santé passe de fail à success. Valeurs valides : 2 à 10.
UnhealthyThreshold	Integer	3	Nombre de fois qu'un serveur backend sain doit échouer consécutivement aux vérifications d'état avant d'être déclaré non sain. Dans ce cas, l'état de santé passe de success à fail. Valeurs valides : 2 à 10.
HealthCheckConnectTimeout	Integer	200	Délai d'attente maximal d'une vérification d'état. Unité : secondes. Valeurs valides : 1 à 300.
HealthCheckInterval	Integer	200	Intervalle entre deux vérifications d'état consécutives. Unité : secondes. Valeurs valides : 5 à 50.
HealthCheckDomain	String	$SERVER_IP	Nom de domaine utilisé pour les vérifications d'état. Valeurs valides : $SERVER_IP: adresse IP privée d'un serveur backend. domain: nom de domaine spécifié. Le nom de domaine doit comporter entre 1 et 80 caractères et peut contenir des lettres minuscules, des chiffres, des traits d'union (-) et des points (.). Remarque Ce paramètre prend effet uniquement si HealthCheckType est défini sur HTTP.
HealthCheckUrl	String	/test/index.html	Chemin vers lequel les requêtes de vérification d'état sont envoyées. Remarque Ce paramètre prend effet uniquement si HealthCheckType est défini sur HTTP.
HealthCheckHttpCode	Array of String	http_2xx	Codes d'état HTTP renvoyés pour les vérifications d'état. Plusieurs codes d'état HTTP sont séparés par des virgules (,). Valeurs valides : http_2xx, http_3xx, http_4xx et http_5xx. Remarque Ce paramètre prend effet uniquement si HealthCheckType est défini sur HTTP.
HttpCheckMethod	String	GET	Méthode HTTP utilisée pour les vérifications d'état. Valeurs valides : GET et HEAD. Remarque Ce paramètre prend effet uniquement si HealthCheckType est défini sur HTTP.
ConnectionDrainEnabled	Boolean	false	Indique si la vidange de connexion est activée. Valeurs valides : true: activé false: désactivé
ConnectionDrainTimeout	Integer	200	Délai d'attente de la vidange de connexion. Unité : secondes. Valeurs valides : 10 à 900.
PreserveClientIpEnabled	Boolean	true	Indique si la préservation de l'adresse IP client est activée. Valeurs valides : true: activé false: désactivé Remarque Remarque : Si AddressIPVersion est défini sur ipv4, la valeur par défaut est true. Si AddressIPVersion est défini sur ipv6, la seule valeur valide est false. true sera pris en charge dans une version ultérieure.
AnyPortEnabled	Boolean	false	Indique si la fonction de transfert des requêtes vers tous les ports est activée. Valeurs valides : true: activé false: désactivé
ResourceGroupId	String	rg-atstuj3rtop****	ID du groupe de ressources auquel appartient le groupe de serveurs.
ServerGroupStatus	String	Available	É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 configuration.
AliUid	Long	165820696622****	UID du compte Alibaba Cloud.
Tags	Array of Tag		Tags ajoutés à l'instance NLB.
Key	String	Test	Clé du tag. Au maximum 10 clés de tags sont renvoyées. La clé du tag peut comporter jusqu'à 64 caractères et ne doit pas contenir `http://` ni `https://`. Elle ne doit pas commencer par `aliyun` ou `acs:`.
Value	String	Test	Valeur du tag. Au maximum 10 valeurs de tags sont renvoyées. La valeur du tag peut comporter jusqu'à 128 caractères et ne doit pas contenir `http://` ni `https://`. Elle ne doit pas commencer par `aliyun` ou `acs:`.
RelatedLoadBalancerIds	Array of String	nlb-83ckzc8d4xlp8o****	Instances NLB.
ServerCount	Integer	2	Nombre de groupes de serveurs associés aux instances NLB.
TotalCount	Integer	1	Nombre d'entrées renvoyées.
NextToken	String	FFmyTO70tTpLG6I3FmYAXGKPd****	Jeton qui détermine le point de départ de la requête. Valeurs valides : Si NextToken est vide, cela indique qu'aucune requête suivante ne doit être envoyée. Si une valeur de NextToken est renvoyée, la valeur est le jeton utilisé pour la requête suivante.
MaxResults	Integer	20	Nombre d'entrées renvoyées par page. Valeurs valides : 1 à 100.

Exemples

Exemples de requêtes

http(s)://[Endpoint]/?Action=ListServerGroups
&ServerGroupIds=["sgp-atstuj3rtoptyui****"]
&ServerGroupNames=["NLB_ServerGroup"]
&ResourceGroupId=rg-atstuj3rtop****
&ServerGroupType=Instance
&VpcId=vpc-bp15zckdt37pq72zv****
&Tag=[{"Key":"Test","Value":"Test"}]
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&MaxResults=20
&RegionId=cn-hangzhou
&Common request parameters

Exemples de réponses réussies

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListServerGroupsResponse>
    <RequestId>54B28E3D-DF70-471B-AA93-08E683A1B45</RequestId>
    <ServerGroups>
        <RegionId>cn-hangzhou</RegionId>
        <ServerGroupId>sgp-atstuj3rtoptyui****</ServerGroupId>
        <ServerGroupName>NLB_ServerGroup</ServerGroupName>
        <ServerGroupType>Instance</ServerGroupType>
        <AddressIPVersion>ipv4</AddressIPVersion>
        <VpcId>vpc-bp15zckdt37pq72zv****</VpcId>
        <Scheduler>Wrr</Scheduler>
        <Protocol>TCP</Protocol>
        <HealthCheck>
            <HealthCheckEnabled>false</HealthCheckEnabled>
            <HealthCheckType>TCP</HealthCheckType>
            <HealthCheckConnectPort>200</HealthCheckConnectPort>
            <HealthyThreshold>2</HealthyThreshold>
            <UnhealthyThreshold>3</UnhealthyThreshold>
            <HealthCheckConnectTimeout>200</HealthCheckConnectTimeout>
            <HealthCheckInterval>200</HealthCheckInterval>
            <HealthCheckDomain>$SERVER_IP</HealthCheckDomain>
            <HealthCheckUrl>/test/index.html</HealthCheckUrl>
            <HealthCheckHttpCode>http2xx</HealthCheckHttpCode>
            <HttpCheckMethod>GET</HttpCheckMethod>
        </HealthCheck>
        <ConnectionDrainEnabled>false</ConnectionDrainEnabled>
        <ConnectionDrainTimeout>200</ConnectionDrainTimeout>
        <PreserveClientIpEnabled>true</PreserveClientIpEnabled>
        <AnyPortEnabled>false</AnyPortEnabled>
        <ResourceGroupId>rg-atstuj3rtop****</ResourceGroupId>
        <ServerGroupStatus>Available</ServerGroupStatus>
        <Tags>
            <Key>Test</Key>
            <Value>Test</Value>
        </Tags>
        <RelatedLoadBalancerIds>nlb-83ckzc8d4xlp8o****</RelatedLoadBalancerIds>
        <ServerCount>2</ServerCount>
    </ServerGroups>
    <TotalCount>1</TotalCount>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <MaxResults>20</MaxResults>
</ListServerGroupsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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" : 200,
      "HealthCheckDomain" : "$SERVER_IP",
      "HealthCheckUrl" : "/test/index.html",
      "HealthCheckHttpCode" : [ "http2xx" ],
      "HttpCheckMethod" : "GET"
    },
    "ConnectionDrainEnabled" : false,
    "ConnectionDrainTimeout" : 200,
    "PreserveClientIpEnabled" : true,
    "AnyPortEnabled" : false,
    "ResourceGroupId" : "rg-atstuj3rtop****",
    "ServerGroupStatus" : "Available",
    "Tags" : [ {
      "Key" : "Test",
      "Value" : "Test"
    } ],
    "RelatedLoadBalancerIds" : [ "nlb-83ckzc8d4xlp8o****" ],
    "ServerCount" : 2
  } ],
  "TotalCount" : 1,
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults" : 20
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez les Codes d'erreur de service.