CreateServerGroup - - Centre de documentation Alibaba Cloud

Crée un groupe de serveurs dans une région spécifiée.

Description de l'opération

L'opération CreateServerGroup est asynchrone. Après l'envoi d'une requête, le système renvoie un identifiant de requête. Cependant, le groupe de serveurs n'est pas encore créé. La tâche de création continue de s'exécuter en arrière-plan. Vous pouvez appeler ListServerGroups pour interroger l'état de création du groupe de serveurs :

Si le groupe de serveurs est dans l'état Creating, le groupe de serveurs est en cours de création.
Si le groupe de serveurs est dans l'état Available, 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.

alb:CreateServerGroup

create

*Groupe de serveurs.

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

alb:ServerGroupProtocol

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
ServerGroupName	string	Oui	Le nom du groupe de serveurs. Le nom doit comporter de 2 à 128 caractères et commencer par une lettre majuscule, une lettre minuscule, un caractère chinois ou un chiffre. Le nom peut contenir des chiffres, des points (.), des traits de soulignement (_), des traits d'union (-) et des espaces.	test
ServerGroupType	string	Non	Le type du groupe de serveurs. Valeurs valides : Instance (par défaut) : type serveur. Ce type de groupe de serveurs prend en charge l'ajout d'instances Ecs, Eni et Eci. Ip : type adresse IP. Ce type de groupe de serveurs prend en charge l'ajout de serveurs back-end par adresse IP. Fc : type Function Compute. Ce type prend en charge l'ajout de serveurs back-end basés sur Function Compute.	Instance
VpcId	string	Non	L'identifiant de l'instance connectée au VPC. Seuls les serveurs de ce VPC peuvent être ajoutés au groupe de serveurs. Remarque Ce paramètre prend effet uniquement lorsque ServerGroupType est défini sur Instance ou Ip.	vpc-bp15zdkdt37pq72zv****
Scheduler	string	Non	L'algorithme de planification. Valeurs valides : Wrr (par défaut) : tourniquet pondéré. Les serveurs back-end avec des poids plus élevés reçoivent plus de requêtes. Wlc : connexions les moins nombreuses pondérées. En plus du poids attribué à chaque serveur back-end, la charge réelle (nombre de connexions) est également prise en compte. Lorsque les poids sont identiques, les serveurs back-end avec le moins de connexions actuelles reçoivent plus de requêtes. Sch : hachage cohérent. Les requêtes avec le même facteur de hachage sont routées vers le même serveur back-end. Si le paramètre UchConfig n'est pas configuré, le facteur de hachage par défaut est l'adresse IP source, et les requêtes provenant de la même adresse IP source sont distribuées au même serveur back-end. Si le paramètre UchConfig est configuré, le facteur de hachage est le paramètre d'URL, et les requêtes avec le même paramètre d'URL sont distribuées au même serveur back-end. Remarque Ce paramètre prend effet uniquement lorsque ServerGroupType est défini sur Instance ou Ip.	Wrr
Protocol	string	Non	Le protocole back-end. Valeurs valides : HTTP (par défaut) : peut être associé à des écouteurs HTTPS, HTTP et QUIC. HTTPS : peut être associé à des écouteurs HTTPS. gRPC : peut être associé à des écouteurs HTTPS et QUIC. Remarque Vous n'avez pas besoin de configurer le protocole back-end lorsque ServerGroupType est défini sur Fc.	HTTP
ResourceGroupId	string	Non	L'identifiant du groupe de ressources.	rg-atstuj3rsop****
HealthCheckConfig	object	Oui	Les configurations de contrôle de santé.	rg-123
HealthCheckConnectPort	integer	Non	Le port du serveur back-end utilisé pour les contrôles de santé. Valeurs valides : 0 à 65535. Valeur par défaut : 0, ce qui indique que le port du serveur back-end est utilisé pour les contrôles de santé.	80
HealthCheckEnabled	boolean	Oui	Indique si les contrôles de santé doivent être activés. Valeurs valides : true : activé. false : désactivé. Remarque Les contrôles de santé sont activés par défaut lorsque ServerGroupType est défini sur Instance ou Ip. Les contrôles de santé sont désactivés par défaut lorsque ServerGroupType est défini sur Fc.	true
HealthCheckHost	string	Non	Le nom de domaine utilisé pour les contrôles de santé. Utiliser l'adresse IP interne du serveur back-end (par défaut) : utilise l'adresse IP interne du serveur back-end comme nom de domaine de contrôle de santé. Spécifier un nom de domaine spécifique : saisissez un nom de domaine. Le nom de domaine doit comporter de 1 à 80 caractères. Le nom de domaine peut contenir des lettres minuscules, des chiffres, des traits d'union (-) et des points (.). Le nom de domaine doit contenir au moins un point (.). Les points (.) ne peuvent pas apparaître au début ou à la fin. Le label de domaine le plus à droite ne peut contenir que des lettres, pas de chiffres ni de traits d'union (-). Les traits d'union (-) ne peuvent pas apparaître au début ou à la fin. Remarque Ce paramètre prend effet uniquement lorsque HealthCheckProtocol est défini sur HTTP, HTTPS ou gRPC.	www.example.com
HealthCheckCodes	array	Non	La liste des codes d'état qui indiquent un état de contrôle de santé normal.
	string	Non	Le code d'état qui indique un état de contrôle de santé normal. Lorsque HealthCheckProtocol est défini sur HTTP ou HTTPS, les valeurs valides pour HealthCheckCodes sont http_2xx (par défaut), http_3xx, http_4xx et http_5xx. Séparez plusieurs codes d'état par des virgules (,). Lorsque HealthCheckProtocol est défini sur gRPC, les valeurs valides pour HealthCheckCodes vont de 0 à 99. Valeur par défaut : 0. La saisie de plage est prise en charge, avec un maximum de 20 valeurs de plage. Séparez plusieurs valeurs de plage par des virgules (,). Remarque Ce paramètre prend effet lorsque HealthCheckProtocol est défini sur HTTP, HTTPS ou gRPC.	http_2xx
HealthCheckHttpVersion	string	Non	La version HTTP pour les contrôles de santé. Valeurs valides : HTTP1.0 et HTTP1.1 (par défaut). Remarque Ce paramètre prend effet uniquement lorsque HealthCheckProtocol est défini sur HTTP ou HTTPS.	HTTP1.1
HealthCheckInterval	integer	Non	L'intervalle entre deux contrôles de santé consécutifs. Unité : secondes. Valeurs valides : 1 à 50. Valeur par défaut : 2.	2
HealthCheckMethod	string	Non	La méthode de contrôle de santé. Valeurs valides : GET : Si le corps de la réponse dépasse 8 Ko, il est tronqué. Cependant, cela n'affecte pas le résultat du contrôle de santé. POST : les contrôles de santé de l'écouteur gRPC utilisent la méthode POST par défaut. HEAD (par défaut) : les contrôles de santé des écouteurs HTTP et HTTPS utilisent la méthode HEAD par défaut. Remarque Ce paramètre prend effet uniquement lorsque HealthCheckProtocol est défini sur HTTP, HTTPS ou gRPC.	HEAD
HealthCheckPath	string	Non	Le chemin de la règle de transfert pour les contrôles de santé. Le chemin doit comporter de 1 à 80 caractères et ne peut contenir que des lettres, des chiffres, les caractères `-/.%?#&=` et les caractères étendus `_;~!（)[]@$^:',+`. L'URL doit commencer par une barre oblique (/). Remarque* Ce paramètre prend effet uniquement lorsque HealthCheckProtocol est défini sur HTTP ou HTTPS.	/test/index.html
HealthCheckProtocol	string	Non	Le protocole de contrôle de santé. Valeurs valides : HTTP : utilise la simulation du comportement d'accès du navigateur en envoyant des requêtes HEAD ou GET pour vérifier si l'application serveur est saine. HTTPS : utilise la simulation du comportement d'accès du navigateur en envoyant des requêtes HEAD ou GET pour vérifier si l'application serveur est saine. Le chiffrement des données est utilisé, ce qui est plus sécurisé que HTTP. TCP : envoie des paquets de négociation SYN pour vérifier si le port du serveur est actif. gRPC : envoie des requêtes POST ou GET pour vérifier si l'application serveur est saine.	HTTP
HealthCheckTimeout	integer	Non	La période maximale d'attente pour une réponse d'un contrôle de santé. Si le serveur back-end ne répond pas correctement dans le délai spécifié, le contrôle de santé échoue. Unité : secondes. Valeurs valides : 1 à 300. Valeur par défaut : 5.	5
HealthyThreshold	integer	Non	Le nombre de contrôles de santé réussis consécutifs requis avant que l'état de contrôle de santé d'un serveur back-end ne passe de fail à success. Valeurs valides : 2 à 10. Valeur par défaut : 3.	3
UnhealthyThreshold	integer	Non	Le nombre de contrôles de santé échoués consécutifs requis avant que l'état de contrôle de santé d'un serveur back-end ne passe de success à fail. Valeurs valides : 2 à 10. Valeur par défaut : 3.	3
StickySessionConfig	object	Non	La configuration de la persistance de session. Remarque Ce paramètre prend effet uniquement lorsque ServerGroupType est défini sur Instance ou Ip.
Cookie	string	Non	Le cookie configuré sur le serveur. Le cookie doit comporter de 1 à 200 caractères et ne peut contenir que des lettres ASCII et des chiffres. Il ne peut pas contenir de virgules (,), de points-virgules (;) ou d'espaces, et ne peut pas commencer par un signe dollar ($). Remarque Ce paramètre prend effet lorsque StickySessionEnabled est défini sur true et StickySessionType est défini sur server.	B490B6EBF6F3CD402E515D22BCDA****
CookieTimeout	integer	Non	Le délai d'attente du cookie. Unité : secondes. Valeurs valides : 1 à 86400. Valeur par défaut : 1000. Remarque Ce paramètre prend effet lorsque StickySessionEnabled est défini sur true et StickySessionType est défini sur Insert.	1000
StickySessionEnabled	boolean	Non	Indique si la persistance de session doit être activée. Valeurs valides : true : activé. false : désactivé. Remarque Ce paramètre prend effet uniquement lorsque ServerGroupType est défini sur Instance ou Ip.	false
StickySessionType	string	Non	La méthode utilisée pour gérer les cookies. Valeurs valides : Insert (par défaut) : insère un cookie. Lorsqu'un client accède pour la première fois à l'équilibreur de charge, l'équilibreur de charge insère un cookie (SERVERID) dans la réponse HTTP ou HTTPS. Les requêtes ultérieures qui transportent ce cookie sont transmises au serveur back-end précédemment enregistré. Server : réécrit un cookie. Lorsque le service d'équilibrage de charge détecte un cookie défini par l'utilisateur, il réécrit le cookie d'origine. Les requêtes ultérieures qui transportent le nouveau cookie sont transmises au serveur back-end précédemment enregistré. Remarque Ce paramètre prend effet lorsque StickySessionEnabled est défini sur true.	Insert
ClientToken	string	Non	Le jeton client utilisé pour garantir l'idempotence de la requête. Générez une valeur de paramètre à partir de votre client pour vous assurer que la valeur est unique parmi les différentes requêtes. ClientToken prend uniquement en charge les caractères ASCII. Remarque Si vous ne spécifiez pas ce paramètre, le système utilise le RequestId de la requête API comme ClientToken. Le RequestId peut varier pour chaque requête API.	5A2CAF0E-5718-45B5-9D4D-70B******
DryRun	boolean	Non	Indique si un test à blanc doit être effectué. Valeurs valides : true : effectue un test à blanc sans créer le groupe de serveurs. Le système vérifie les paramètres requis, la syntaxe de la requête et les restrictions métier. Si la vérification échoue, l'erreur correspondante est renvoyée. Si la vérification réussit, le code d'erreur `DryRunOperation` est renvoyé. false (par défaut) : envoie une requête normale. Une fois la vérification réussie, un code d'état HTTP 2xx est renvoyé et l'opération est exécutée.	false
Ipv6Enabled	boolean	Non	Indique si IPv6 doit être activé.	true
UpstreamKeepaliveEnabled	boolean	Non	Indique si les connexions keepalive en amont doivent être activées. true : activé. false (par défaut) : désactivé.	false
ServiceName	string	Non	Ce paramètre s'applique uniquement aux scénarios ALB Ingress et spécifie le nom du K8s Service qui correspond au groupe de serveurs.	test
UchConfig	object	Non	Les paramètres de hachage cohérent d'URL.
Type	string	Oui	Le type de paramètre. Définissez la valeur sur QueryString.	QueryString
Value	string	Oui	La valeur du paramètre de hachage cohérent.	abc
ConnectionDrainConfig	object	Non	La configuration de vidage des connexions. Une fois le vidage des connexions activé, lorsqu'un serveur back-end est supprimé ou qu'une défaillance de vérification de l'état se produit, le service d'équilibrage de charge permet aux connexions existantes de continuer la transmission normale des données pendant une période spécifiée. Remarque Les instances de l'Édition de base ne prennent pas en charge le vidage des connexions. Seules les instances de l'Édition Standard et de l'Édition WAF améliorée prennent en charge cette fonctionnalité. Les groupes de serveurs de type serveur et de type IP prennent en charge le vidage des connexions. Les groupes de serveurs de type Function Compute ne le prennent pas en charge.
ConnectionDrainEnabled	boolean	Non	Indique si le vidage des connexions doit être activé. true : activé. false : désactivé (par défaut).	false
ConnectionDrainTimeout	integer	Non	Le délai d'attente du vidage des connexions. Valeurs valides : 0 à 900. Valeur par défaut : 300.	300
SlowStartConfig	object	Non	La configuration de démarrage lent. Une fois le démarrage lent activé, les serveurs back-end nouvellement ajoutés sont préparés pendant une période spécifiée. Le nombre de requêtes transmises au serveur augmente de manière linéaire. Remarque Les instances de l'Édition de base ne prennent pas en charge le démarrage lent. Seules les instances de l'Édition Standard et de l'Édition WAF améliorée prennent en charge cette fonctionnalité. Les groupes de serveurs back-end de type serveur et de type IP prennent en charge la configuration du démarrage lent. Les groupes de serveurs back-end de type Function Compute ne la prennent pas en charge. Le démarrage lent ne peut être activé que lorsque l'algorithme de répartition back-end est le round-robin pondéré.
SlowStartEnabled	boolean	Non	Indique si le démarrage lent doit être activé. true : activé. false : désactivé (par défaut).	false
SlowStartDuration	integer	Non	La durée du démarrage lent. Valeurs valides : 30 à 900. Valeur par défaut : 30.	30
Tag	array<object>	Non	Les balises.
	object	Non	La structure de la balise.
Key	string	Non	La clé de la balise. La clé de la balise peut comporter jusqu'à 128 caractères et ne peut pas commencer par aliyun ou acs:, ni contenir http:// ou https://.	env
Value	string	Non	La valeur de la balise. La valeur de la balise peut comporter jusqu'à 128 caractères et ne peut pas commencer par aliyun ou acs:, ni contenir http:// ou https://.	product
CrossZoneEnabled	boolean	Non	Indique si l'équilibrage de charge inter-zones doit être activé pour le groupe de serveurs. Valeurs valides : true : activé (par défaut). false : désactivé. Remarque Les instances de l'Édition de base ne prennent pas en charge la liaison de groupes de serveurs avec l'équilibrage de charge inter-zones désactivé. Seules les instances de l'Édition Standard et de l'Édition WAF améliorée prennent en charge cette fonctionnalité. Les groupes de serveurs de type serveur et de type IP prennent en charge la désactivation de l'équilibrage de charge inter-zones. Les groupes de serveurs de type Function Compute ne la prennent pas en charge. La persistance de session n'est pas prise en charge lorsque l'équilibrage de charge inter-zones est désactivé.	true
IpVersionAffinityMode	string	Non	Le mode d'affinité de version IP.	Affinity

Éléments de réponse

Élément	Type	Description	Exemple
	object	La structure de la réponse.
JobId	string	L'identifiant de la tâche asynchrone.	72dcd26b-f12d-4c27-b3af-18f6aed5****
RequestId	string	L'identifiant de la requête.	365F4154-92F6-4AE4-92F8-7FF******
ServerGroupId	string	L'identifiant du groupe de serveurs.	sgp-8ilqs4axp6******

Exemples

JSON format

{
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF******",
  "ServerGroupId": "sgp-8ilqs4axp6******"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	QuotaExceeded.ServerGroupsNum	The quota of %s is exceeded, usage %s/%s.	Le quota %s a été dépassé. Utilisation actuelle : %s. Quota : %s.
400	Mismatch.LoadBalancerEditionAndSlowStartEnable	The %s and %s are mismatched.	Les paramètres %s et %s ne correspondent pas.
400	Mismatch.ServerGroupSchedulerAndSlowStartEnable	The %s and %s are mismatched.	Les paramètres %s et %s ne correspondent pas.
400	QuotaExceeded.SlowStartDuration	The quota of %s is exceeded, usage %s/%s.	Le paramètre %s dépasse la limite du quota. Valeur actuelle : %s. Quota : %s.
400	UnsupportedFeature.SlowStart	The feature of %s is not supported.	La fonctionnalité %s n'est pas prise en charge.
400	Mismatch.LoadBalancerEditionAndConnectionDrain	The %s and %s are mismatched.	Les paramètres %s et %s ne correspondent pas.
400	QuotaExceeded.ConnectionDrainTimeout	The quota of %s is exceeded, usage %s/%s.	Le paramètre %s dépasse la limite du quota. Valeur actuelle : %s. Quota : %s.
400	UnsupportedFeature.ConnectionDrain	The feature of %s is not supported.	La fonctionnalité %s n'est pas prise en charge.
400	NotExist.ResourceGroup	ResourceGroup does not exist.	Le groupe de ressources n'existe pas.
400	OperationDenied.VpcNotSupportIpv6	The operation is not allowed because of VpcNotSupportIpv6.	Le VPC ne prend pas en charge IPv6 et ne peut pas être converti en double pile.
400	UnsupportedFeature.FcServerGroup	Server groups of type FC are not supported.	Le groupe de serveurs de type FC n'est pas pris en charge.
404	ResourceNotFound.Vpc	The specified resource %s is not found.	Le VPC n'existe pas.

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

Notes de version

Consultez Notes de version pour la liste complète.