CreateServerGroup - - Centre de documentation Alibaba Cloud

Crée un groupe de serveurs pour une instance Gateway Load Balancer (GWLB).

Description de l'opération

CreateServerGroup est une opération asynchrone. Après l'envoi d'une requête, le système renvoie un identifiant de requête et exécute la tâche en arrière-plan. Vous pouvez appeler l'opération ListServerGroups pour interroger l'état de la tâche.

Si le groupe de serveurs est dans l'état Creating, cela indique que le groupe de serveurs est en cours de création.
Si le groupe de serveurs est dans l'état Available, cela indique que le groupe de serveurs est créé.

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.

gwlb:CreateServerGroup

create

*ServerGroup

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

*VPC

acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
ServerGroupType	string	Non	Le type du groupe de serveurs. Valeurs valides : Instance (par défaut) : permet de spécifier des ressources de type Ecs, Eni ou Eci. Ip : permet d'ajouter des serveurs en spécifiant leurs adresses IP.	Instance
ServerGroupName	string	Non	Le nom du groupe de serveurs. Le nom doit comporter de 2 à 128 caractères et peut contenir des chiffres, des points (.), des traits de soulignement (_) et des traits d'union (-). Il doit commencer par une lettre.	testServerGroupName
Protocol	string	Non	Le protocole backend. Valeur valide : GENEVE (par défaut) Valeurs valides : GENEVE : GENEVE.	GENEVE
Scheduler	string	Non	L'algorithme de planification. Valeurs valides : 5TCH (par défaut) : spécifie un hachage cohérent basé sur les facteurs suivants : adresse IP source, adresse IP de destination, port source, protocole et port de destination. Les requêtes contenant les mêmes informations basées sur les facteurs précédents sont transmises au même serveur backend. 3TCH : spécifie un hachage cohérent basé sur les facteurs suivants : adresse IP source, adresse IP de destination et protocole. Les requêtes contenant les mêmes informations basées sur les facteurs précédents sont transmises au même serveur backend. 2TCH : spécifie un hachage cohérent basé sur les facteurs suivants : adresse IP source et adresse IP de destination. Les requêtes contenant les mêmes informations basées sur les facteurs précédents sont transmises au même serveur backend.	5TCH
ServerFailoverMode	string	Non	Indique comment GWLB traite les requêtes sur les connexions existantes lorsqu'un serveur backend ne fonctionne pas comme prévu. Valeurs valides : NoRebalance (par défaut) : GWLB continue de transmettre les requêtes sur les connexions existantes au serveur backend indisponible. Rebalance : GWLB transmet les requêtes sur les connexions existantes aux serveurs backend sains restants.	NoRebalance
VpcId	string	Oui	L'identifiant du VPC. Remarque Si ServerGroupType est défini sur Instance, seuls les serveurs du VPC spécifié peuvent être ajoutés au groupe de serveurs.	vpc-bp15zckdt37pq72zv****
ResourceGroupId	string	Non	L'identifiant du groupe de ressources.	rg-atstuj3rtop****
ConnectionDrainConfig	object	Non	Les configurations de vidage des connexions.
ConnectionDrainEnabled	boolean	Non	Indique si le vidage des connexions doit être activé. Valeurs valides : true false	false
ConnectionDrainTimeout	integer	Non	Le délai d'expiration du vidage des connexions. Unité : secondes Valeurs valides : 1 à 3600. Valeur par défaut : 300.	300
HealthCheckConfig	object	Non	Les configurations de vérification de l'état de santé.
HealthCheckConnectPort	integer	Non	Le port du serveur backend utilisé pour les vérifications de l'état de santé. Valeurs valides : 1 à 65535. Valeur par défaut : 80.	80
HealthCheckConnectTimeout	integer	Non	Le délai d'expiration maximum pour une réponse de vérification de l'état de santé. Unité : secondes. Valeurs valides : 1 à 300. Valeur par défaut : 5.	5
HealthCheckDomain	string	Non	Le nom de domaine utilisé pour les vérifications de l'état de santé. Valeurs valides : $SERVER_IP (par défaut) : l'adresse IP privée d'un serveur backend. domain : un nom de domaine. Le nom de domaine doit comporter de 1 à 80 caractères et peut contenir des lettres, des chiffres, des traits d'union (-) et des points (.). Remarque Ce paramètre prend effet uniquement si vous définissez HealthCheckProtocol sur HTTP.	$SERVER_IP
HealthCheckEnabled	boolean	Non	Indique si les vérifications de l'état de santé doivent être activées. Valeurs valides : true (par défaut) false	true
HealthCheckHttpCode	array	Non	Les codes d'état HTTP que le système renvoie pour les vérifications de l'état de santé.
	string	Non	Les codes d'état HTTP renvoyés pour les vérifications de l'état de santé. Plusieurs codes d'état HTTP sont séparés par des virgules (,). Valeurs valides : http_2xx http_3xx http_4xx http_5xx Valeur par défaut : http_2xx. Remarque Ce paramètre prend effet uniquement si vous définissez HealthCheckProtocol sur HTTP.	http_2xx
HealthCheckInterval	integer	Non	L'intervalle auquel les vérifications de l'état de santé sont effectuées. Unité : secondes. Valeurs valides : 1 à 50. Valeur par défaut : 10.	10
HealthCheckPath	string	Non	Le chemin utilisé pour les vérifications de l'état de santé. Il doit comporter de 1 à 80 caractères et peut contenir 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 peut également contenir les caractères étendus suivants : _ ; ~ ! ( ) * [ ] @ $ ^ : ' , + = Il doit commencer par une barre oblique (/). Remarque Ce paramètre prend effet uniquement si vous définissez HealthCheckProtocol sur HTTP.	/test/index.html
HealthCheckProtocol	string	Non	Le protocole utilisé pour les vérifications de l'état de santé. Valeurs valides : TCP (par défaut) : GWLB effectue des vérifications de l'état de santé TCP en envoyant des paquets SYN à un serveur backend pour vérifier si le port du serveur backend est disponible pour recevoir des requêtes. HTTP : GWLB effectue des vérifications de l'état de santé HTTP pour vérifier si les serveurs backend sont sains en envoyant des requêtes GET qui simulent un accès depuis des navigateurs.	TCP
HealthyThreshold	integer	Non	Le nombre de fois qu'un serveur backend non sain doit réussir consécutivement les vérifications de l'état de santé avant d'être déclaré sain. Dans ce cas, l'état de vérification de l'état de santé du serveur backend passe de fail à success. Valeurs valides : 2 à 10. Valeur par défaut : 2.	2
UnhealthyThreshold	integer	Non	Le nombre de fois qu'un serveur backend sain doit échouer consécutivement aux vérifications de l'état de santé avant d'être déclaré non sain. Dans ce cas, l'état de vérification de l'état de santé du serveur backend passe de success à fail. Valeurs valides : 2 à 10. Valeur par défaut : 2.	2
HealthCheckReq	string	Non
HealthCheckExp	string	Non
Tag	array<object>	Non	Les clés de balise. Vous pouvez spécifier jusqu'à 20 balises lors de chaque appel.
	object	Non	La balise.
Key	string	Non	La clé de balise. 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 `acs:` ou `aliyun`. La clé de balise ne peut pas contenir `http://` ou `https://`.	testTagKey
Value	string	Non	La valeur de balise. La valeur de balise peut comporter jusqu'à 256 caractères et ne peut pas contenir `http://` ou `https://`.	testTagValue
DryRun	boolean	Non	Indique si un test à blanc uniquement doit être effectué sans exécuter la requête réelle. Valeurs valides : true : effectue uniquement un test à blanc. Le système vérifie si la requête présente des problèmes potentiels, notamment des valeurs de paramètre manquantes, une syntaxe de requête incorrecte et des limites de service. Si la requête échoue au test à blanc, un code d'erreur est renvoyé. Si la requête réussit le test à blanc, le code d'erreur `DryRunOperation` est renvoyé. false (par défaut) : effectue un test à blanc et exécute la requête réelle. Si la requête réussit le test à blanc, un code d'état HTTP 2xx est renvoyé et l'opération est exécutée.	False
ClientToken	string	Non	Le jeton client utilisé pour garantir l'idempotence de la requête. Vous pouvez utiliser le client pour générer le jeton, mais vous devez vous assurer que le jeton est unique parmi les différentes requêtes. Le jeton client ne peut contenir que des caractères ASCII. Remarque Si vous ne spécifiez pas ce paramètre, le système utilise automatiquement l'identifiant de requête comme jeton client. L'identifiant de requête peut être différent pour chaque requête.	123e4567-e89b-12d3-a456-42665544****

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	54B48E3D-DF70-471B-AA93-08E683A1B45
ServerGroupId	string	L'identifiant du groupe de serveurs.	sgp-atstuj3rtoptyui****

Exemples

JSON format

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "ServerGroupId": "sgp-atstuj3rtoptyui****"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	IllegalParam.HealthCheckProtocol	The param of %s is illegal.	The health check protocol is invalid. Check the input parameters.
400	QuotaExceeded.ServerGroupsNum	The quota of %s is exceeded for resource %s, usage %s/%s.	The quota gwlb_quota_servergroups_num has exceeded the quota limit.
400	DuplicatedParam.TagKey	The param of %s is duplicated.	The parameter of tag key is duplicated.
400	IllegalParam.TagKey	The param of %s is illegal.
404	ResourceNotFound.Vpc	The specified resource of %s is not found.	The specified virtual private cloud resource does not exist.

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

Notes de version

Consultez Notes de version pour la liste complète.