AddServersToServerGroup - - Centre de documentation Alibaba Cloud

Ajoute des serveurs backend à un groupe de serveurs.

Description de l'opération

AddServersToServerGroup est une opération asynchrone. Une fois l'identifiant de requête renvoyé, le serveur backend peut ne pas être encore ajouté car le système traite toujours la tâche en arrière-plan.

Appelez ListServerGroups pour interroger l'état du groupe de serveurs :

Si le groupe de serveurs est dans l'état Configuring, le groupe de serveurs est en cours de modification.
Si le groupe de serveurs est dans l'état Available, le groupe de serveurs est en cours d'exécution.

Appelez ListServerGroupServers pour interroger l'état du serveur backend :

Si le serveur backend est dans l'état Adding, le serveur backend est en cours d'ajout au groupe de serveurs.
Si le serveur backend est dans l'état Available, le serveur backend est en cours d'exécution.

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

create

*ServerGroup

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

Instance

acs:alb:{#regionId}:{#accountId}:ecs/{#InstanceId}

NetworkInterface

acs:alb:{#regionId}:{#accountId}:eni/{#NetworkInterfaceId}

ContainerGroup

acs:alb:{#regionId}:{#accountId}:eci/{#ContainerGroupId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
ServerGroupId	string	Oui	L'identifiant du groupe de serveurs.	sgp-atstuj3rtop****
Servers	array<object>	Oui	La liste des serveurs backend. Vous pouvez ajouter jusqu'à 200 serveurs en un seul appel.
	object	Non	La structure du serveur backend.
Description	string	Non	La description du serveur backend. La description doit comporter de 2 à 256 caractères et ne peut pas commencer par http:// ou https://.	test
Port	integer	Non	Le port utilisé par le serveur backend. Valeurs valides : 1 à 65535. Vous pouvez ajouter jusqu'à 200 serveurs en un seul appel. Remarque Ce paramètre est requis lorsque ServerType est défini sur Ecs, Eni, Eci ou Ip. Ce paramètre n'est pas requis lorsque ServerType est défini sur Fc.	80
ServerId	string	Non	L'identifiant du serveur backend. Vous pouvez ajouter jusqu'à 200 serveurs en un seul appel. Si le groupe de serveurs est de type Instance, ce paramètre spécifie l'identifiant de ressource d'une instance Ecs, Eni ou Eci. Si le groupe de serveurs est de type Ip, ce paramètre spécifie une adresse IP. Si le groupe de serveurs est de type Fc, ce paramètre spécifie l'Alibaba Cloud Resource Name (ARN) d'une fonction Function Compute.	i-uf616vu8me******
ServerIp	string	Non	L'adresse IP. Vous pouvez ajouter jusqu'à 200 serveurs en un seul appel. Lorsque ServerType est défini sur Eni, vous pouvez spécifier l'adresse IP privée principale ou une adresse IP privée secondaire de l'ENI. Remarque Ce paramètre n'est pas requis lorsque ServerType est défini sur Fc.	192.168.1.1
ServerType	string	Oui	Le type du serveur backend. Vous pouvez ajouter jusqu'à 200 serveurs en un seul appel. Valeurs valides : Ecs : instance ECS. Eni : instance de contrôleur d'interface réseau (NIC) ENI. Eci : instance de conteneur élastique ECI. Ip : adresse IP. Fc : Function Compute.	Ecs
Weight	integer	Non	Le poids du serveur backend. Valeurs valides : 0 à 100. Valeur par défaut : 100. Si le poids est défini sur 0, aucune requête n'est transférée au serveur backend. Vous pouvez ajouter jusqu'à 200 serveurs en un seul appel. Remarque Ce paramètre n'est pas requis lorsque ServerType est défini sur Fc.	100
RemoteIpEnabled	boolean	Non	Indique si la fonctionnalité d'IP distante doit être activée. Vous pouvez ajouter jusqu'à 200 serveurs en un seul appel. Valeurs valides : true : activée. false : désactivée. Remarque Ce paramètre prend effet uniquement lorsque ServerType est défini sur Ip.	false
ClientToken	string	Non	Le jeton client utilisé pour garantir l'idempotence de la requête. Générez une valeur de paramètre depuis votre client pour garantir l'unicité entre 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 différer pour chaque requête API.	593B0448-D13E-4C56-AC0D-FDF0******
DryRun	boolean	Non	Indique si un test à blanc doit être effectué. Valeurs valides : true : effectue un test à blanc sans ajouter de serveurs backend au groupe de serveurs. Le système vérifie les paramètres requis, le format de la requête et les limites du service. 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) : effectue un test à blanc et envoie la requête. Si la vérification réussit, un code d'état HTTP 2xx est renvoyé et l'opération est effectuée.	false

É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-7FF34******

Exemples

JSON format

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

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	ResourceQuotaExceeded.ServerAddedNum	The quota of %s is exceeded for resource %s, usage %s/%s.
400	IncorrectStatus.ServerGroup	The status of %s [%s] is incorrect.	The status of %s [%s] is incorrect.
400	Conflict.BackendServer	There is already %s having the same configuration with %s.
400	OperationDenied.VpcVportNotFound	The operation is not allowed because of %s.	The operation is not allowed because of %s.
400	IncorrectStatus.Eni	The status of %s [%s] is incorrect.	The status of %s [%s] is incorrect.
400	ResourceInUse.IP	The specified resource %s is in use.	The specified resource %s is in use.
400	OperationDenied.NoAvailableVSwitch	The operation is not allowed because of %s.	The operation is not allowed because of %s.
400	OperationDenied.VgwVipNotFound	The operation is not allowed because of %s.	The operation is not allowed because of %s.
400	OperationDenied.CloudBox	The operation is not allowed because of %s.	The operation is not allowed because of %s.
400	Mismatch.Type	The %s is mismatched for %s and %s.	The %s is mismatched for %s and %s.
400	Mismatch.VpcId	The %s is mismatched for %s and %s.	The %s is mismatched for %s and %s.
400	ResourceQuotaExceeded.LoadBalancerServersNum	The quota of %s is exceeded for resource %s, usage %s/%s.
400	ResourceInConfiguring	The specified resource of %s is being configured. Please try again later.
400	DuplicatedParam.BackendServer	The param of %s is duplicated.	The param of %s is duplicated.
400	OperationDenied.EciNotSupportJobType	The operation is not allowed because of eci not support job type.	The operation is not allowed because of eci not support job type.
400	IllegalParam.ServerIp	The param of ServerIp is illegal.
400	Mismatch.ServerType	The %s is mismatched for %s and %s.
400	ServiceUnavailable	The request has failed due to a temporary failure of the server.	The request has failed due to a temporary failure of the server.
403	Forbidden.ServerGroup	Authentication has failed for ServerGroup.
404	ResourceNotFound.ServerGroup	The specified resource %s is not found.
404	ResourceNotFound.Ecs	The specified resource %s is not found.
404	ResourceNotFound.Eci	The specified resource %s is not found.
404	ResourceNotFound.Eni	The specified resource %s is not found.	The specified resource %s is not found.

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

Notes de version

Consultez Notes de version pour la liste complète.