UpdateServerGroupAttribute - - Centre de documentation Alibaba Cloud

Modifie les attributs d'un groupe de serveurs Server Load Balancer.

Description de l'opération

UpdateServerGroupAttribute 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. La configuration du groupe de serveurs n'est pas mise à jour immédiatement. Vous pouvez appeler l'opération ListServerGroups pour interroger l'état du groupe de serveurs.

Si un groupe de serveurs est dans l'état Configuring, sa configuration est en cours de mise à jour.
Si un groupe de serveurs est dans l'état Available, sa configuration est mise à jour.

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

update

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
ServerGroupId	string	Oui	L'identifiant du groupe de serveurs.	sgp-atstuj3rtoptyui****
ServerGroupName	string	Non	Le nom du groupe de serveurs. Le nom doit comporter de 2 à 128 caractères, commencer par une lettre ou un caractère chinois, et peut contenir des chiffres, des points (.), des traits de soulignement (_) et des tirets (-).	testServerGroupName
Scheduler	string	Non	L'algorithme de planification. Valeurs valides : 5TCH : hachage 5-tuple. Les paquets sont distribués aux serveurs backend en fonction d'un hachage 5-tuple de l'adresse IP source, de l'adresse IP de destination, du port source, du port de destination et du protocole. Cela garantit que le même flux est toujours planifié vers le même serveur backend. 3TCH : hachage 3-tuple. Les paquets sont distribués aux serveurs backend en fonction d'un hachage 3-tuple de l'adresse IP source, de l'adresse IP de destination et du protocole. Cela garantit que le même flux est toujours planifié vers le même serveur backend. 2TCH : hachage 2-tuple. Les paquets sont distribués aux serveurs backend en fonction d'un hachage 2-tuple de l'adresse IP source et de l'adresse IP de destination. Cela garantit que le même flux est toujours planifié vers le même serveur backend.	5TCH
ServerFailoverMode	string	Non	La méthode utilisée pour gérer les connexions existantes lorsqu'un serveur backend rencontre une anomalie. Valeurs valides : NoRebalance : les connexions existantes ne sont pas rééquilibrées. Rebalance : les connexions existantes sont rééquilibrées.	NoRebalance
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.	300
HealthCheckConfig	object	Non	Les configurations des vérifications de l'état de santé.
HealthCheckConnectPort	integer	Non	Le port utilisé pour les vérifications de l'état de santé des serveurs backend. Valeurs valides : 1 à 65535.	80
HealthCheckConnectTimeout	integer	Non	Le délai d'expiration maximal d'une réponse de vérification de l'état de santé. Unité : secondes. Valeurs valides : 1 à 300.	5
HealthCheckDomain	string	Non	Le nom de domaine utilisé pour les vérifications de l'état de santé. Valeurs valides : $SERVER_IP : l'adresse IP privée d'un serveur backend. domain : un nom de domaine spécifié. Le nom de domaine doit comporter de 1 à 80 caractères et peut contenir des lettres, des chiffres, des tirets (-) et des points (.). Remarque Ce paramètre prend effet uniquement lorsque HealthCheckProtocol est défini sur HTTP.	$SERVER_IP
HealthCheckEnabled	boolean	Non	Indique si les vérifications de l'état de santé doivent être activées. Valeurs valides : true false	true
HealthCheckHttpCode	array	Non	La liste des codes d'état HTTP qui indiquent un état sain.
	string	Non	Le code d'état HTTP qui indique un état sain. Vous pouvez spécifier plusieurs codes d'état HTTP. Séparez les codes d'état multiples par des virgules (,). Valeurs valides : http_2xx : un code d'état HTTP 2xx indique un état sain. http_3xx : un code d'état HTTP 3xx indique un état sain. http_4xx : un code d'état HTTP 4xx indique un état sain. http_5xx : un code d'état HTTP 5xx indique un état sain. Valeur par défaut : http_2xx. Remarque Ce paramètre prend effet uniquement lorsque HealthCheckProtocol est défini 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.	10
HealthCheckPath	string	Non	Le chemin utilisé pour les vérifications de l'état de santé. Le chemin doit comporter de 1 à 80 caractères et peut contenir des lettres, des chiffres et les caractères spéciaux suivants : `-/.%?#&`. Il doit commencer par une barre oblique (/). Remarque Ce paramètre prend effet uniquement lorsque HealthCheckProtocol est défini sur HTTP.	/test/index.html
HealthCheckProtocol	string	Non	Le protocole utilisé pour les vérifications de l'état de santé. Valeurs valides : TCP : des paquets TCP SYN sont envoyés à un serveur backend pour vérifier si le port du serveur backend est accessible. HTTP : des requêtes GET sont envoyées à un serveur backend pour vérifier si l'application du serveur est saine.	TCP
HealthyThreshold	integer	Non	Le nombre de vérifications de l'état de santé réussies consécutives requises pour faire passer l'état de vérification de l'état de santé d'un serveur backend de failed à successful. Valeurs valides : 2 à 10.	2
UnhealthyThreshold	integer	Non	Le nombre de vérifications de l'état de santé échouées consécutives requises pour faire passer l'état de vérification de l'état de santé d'un serveur backend de successful à failed. Valeurs valides : 2 à 10.	2
HealthCheckReq	string	Non
HealthCheckExp	string	Non
DryRun	boolean	Non	Indique si un test à blanc doit être effectué. Valeurs valides : true : effectue un test à blanc. Le système vérifie les paramètres requis, le format de la requête et les limites du service. Si la requête échoue au test à blanc, un message 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 envoie la requête. 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 un jeton, mais vous devez vous assurer que le jeton est unique parmi les différentes requêtes. Le jeton ne peut contenir que des caractères ASCII. Remarque Si vous ne spécifiez pas ce paramètre, le système utilise automatiquement le RequestId de la requête comme ClientToken. Le RequestId peut être différent pour chaque requête.	123e4567-e89b-12d3-a456-42665544****

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les données de réponse.
RequestId	string	L'identifiant de la requête.	54B48E3D-DF70-471B-AA93-08E683A1B45

Exemples

JSON format

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45\n"
}

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	IncorrectStatus.ServerGroup	The status of %s [%s] is incorrect.	The status of %s [%s] is incorrect.
400	OperationDenied.SchedulerNotConfigurable	The scheduling algorithm of server group is configurable only when TCP idle timeout of listener is default value.	The scheduling algorithm of server group is configurable only when TCP idle timeout of listener is default value.
404	ResourceNotFound.ServerGroup	The specified resource of %s is not found.	The specified server group 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.