UpdateServerGroupAttribute - - Centre de documentation Alibaba Cloud

Met à jour les paramètres d'un groupe de serveurs, tels que le contrôle de santé, la persistance de session, le nom, l'algorithme de planification et le protocole.

Description de l'opération

L'API UpdateServerGroupAttribute est asynchrone. Après avoir appelé cette API, le système renvoie un identifiant de requête et exécute la mise à jour en arrière-plan. Le changement de configuration n'est pas immédiat. Vous pouvez appeler l'API ListServerGroups pour interroger l'état du groupe de serveurs :

Un état Configuring indique que le groupe de serveurs est en cours de mise à jour.
Un état Available indique que la mise à jour est terminée.

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

update

*ServerGroup

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
ServerGroupName	string	Non	Le nom du groupe de serveurs. Le nom doit comporter de 2 à 128 caractères, commencer par une lettre, un chiffre ou un caractère chinois, et peut contenir des lettres, des chiffres, des points (.), des traits de soulignement (_), des traits d'union (-) et des espaces.	test
Scheduler	string	Non	L'algorithme de planification. Valeurs valides : Wrr : tourniquet pondéré. Les serveurs backend avec des poids plus élevés reçoivent plus de requêtes. Wlc : connexions minimales pondérées. L'algorithme achemine les requêtes en fonction à la fois du poids et de la charge actuelle (nombre de connexions) de chaque serveur backend. Si les serveurs backend ont le même poids, celui qui a le moins de connexions actives reçoit plus de requêtes. Sch : hachage cohérent. L'adresse IP source est utilisée comme clé de hachage par défaut. Si vous configurez le paramètre UchConfig, un paramètre d'URL est utilisé comme clé de hachage à la place.	Wrr
ClientToken	string	Non	Le jeton client, qui est utilisé pour garantir l'idempotence de la requête. Générez une valeur unique sur votre client et assurez-vous que la valeur est unique pour chaque requête. 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 le RequestId de la requête API comme jeton client.	5A2CFF0E-5718-45B5-9D4D-70B3******
DryRun	boolean	Non	Indique si un test à blanc doit être effectué. Valeurs valides : true : effectue un test à blanc pour vérifier la validité de la requête sans modifier la ressource. Le système vérifie les paramètres requis, le format de la requête et les limites de service. Si la vérification réussit, le code d'erreur DryRunOperation est renvoyé. false (par défaut) : envoie une requête normale. Si la requête est valide, l'opération est effectuée et un code d'état HTTP 2xx est renvoyé.	true
HealthCheckConfig	object	Non	Les paramètres de contrôle de santé.	true
HealthCheckConnectPort	integer	Non	Le port sur le serveur backend utilisé pour les contrôles de santé. Valeurs valides : 0 à 65535. Si vous définissez cette valeur sur 0, le port du serveur backend est utilisé pour les contrôles de santé. Remarque Ce paramètre prend effet uniquement lorsque HealthCheckEnabled est défini sur true.	80
HealthCheckEnabled	boolean	Non	Indique si les contrôles de santé doivent être activés. Valeurs valides : true : active les contrôles de santé. false : désactive les contrôles de santé.	true
HealthCheckHost	string	Non	Le nom de domaine utilisé pour les contrôles de santé. Utiliser l'adresse IP privée du serveur backend (par défaut) : l'adresse IP privée du serveur backend est utilisée pour le contrôle de santé. Spécifier un nom de domaine : saisissez un nom de domaine qui répond aux exigences suivantes : Le nom de domaine doit comporter de 1 à 80 caractères. Il peut contenir des lettres minuscules, des chiffres, des traits d'union (-) et des points (.). Il doit contenir au moins un point (.), qui ne peut être ni le premier ni le dernier caractère. Le label de domaine le plus à droite ne peut contenir que des lettres et ne peut pas contenir de chiffres ou de traits d'union (-). Un trait d'union (-) ne peut être ni le premier ni le dernier caractère. Remarque Ce paramètre prend effet uniquement lorsque HealthCheckProtocol est défini sur HTTP, HTTPS ou gRPC.	example.com
HealthCheckCodes	array	Non	Les codes d'état HTTP qui indiquent un contrôle de santé réussi.
	string	Non	Le code d'état qui indique un contrôle de santé réussi. Lorsque HealthCheckProtocol est défini sur HTTP ou HTTPS, vous pouvez spécifier http_2xx (par défaut), http_3xx, http_4xx et http_5xx. Séparez les valeurs multiples par des virgules (,). Lorsque HealthCheckProtocol est défini sur gRPC, les codes d'état valides vont de 0 à 99. La valeur par défaut est 0. Vous pouvez spécifier jusqu'à 20 plages. Séparez les plages multiples par des virgules (,). Remarque Ce paramètre prend effet uniquement lorsque HealthCheckEnabled est défini sur true et HealthCheckProtocol est défini sur HTTP, HTTPS ou gRPC.	200
HealthCheckHttpVersion	string	Non	La version HTTP pour les contrôles de santé. Valeurs valides : HTTP1.0 HTTP1.1 Remarque Ce paramètre prend effet uniquement lorsque HealthCheckEnabled est défini sur true et HealthCheckProtocol est défini sur HTTP ou HTTPS.	HTTP1.1
HealthCheckInterval	integer	Non	L'intervalle, en secondes, entre les contrôles de santé. Valeurs valides : 1 à 50. Remarque Ce paramètre prend effet uniquement lorsque HealthCheckEnabled est défini sur true.	5
HealthCheckMethod	string	Non	La méthode utilisée pour les contrôles de santé. Valeurs valides : GET : si le corps de la réponse dépasse 8 Ko, il est tronqué. Cela n'affecte pas le résultat du contrôle de santé. POST : par défaut, les écouteurs gRPC utilisent POST pour les contrôles de santé. HEAD : par défaut, les écouteurs HTTP et HTTPS utilisent HEAD pour les contrôles de santé. Remarque Ce paramètre prend effet uniquement lorsque HealthCheckEnabled est défini sur true et HealthCheckProtocol est défini sur HTTP, HTTPS ou gRPC.	HEAD
HealthCheckPath	string	Non	Le chemin auquel les requêtes de contrôle de santé sont envoyées. Le chemin doit comporter de 1 à 80 caractères. Il peut contenir des lettres, des chiffres et les caractères suivants : `-/.%?#&=` et `_~;!()[]@$^:',+`. Le chemin doit commencer par `/`. Remarque* Ce paramètre prend effet uniquement lorsque HealthCheckEnabled est défini sur true et HealthCheckProtocol est défini sur HTTP ou HTTPS.	/test/index.html
HealthCheckProtocol	string	Non	Le protocole utilisé pour les contrôles de santé. Valeurs valides : HTTP : le système vérifie si l'application est saine en envoyant une requête HEAD ou GET qui simule une visite de navigateur. HTTPS : le système vérifie si l'application est saine en envoyant une requête HEAD ou GET qui simule une visite de navigateur. Les données sont chiffrées, ce qui est plus sécurisé que HTTP. TCP : le système vérifie que le port est ouvert en envoyant un paquet SYN. gRPC : le système vérifie si l'application est saine en envoyant une requête POST ou GET.	HTTP
HealthCheckTimeout	integer	Non	Le délai d'attente, en secondes, pour une réponse de contrôle de santé. Si un serveur backend ne répond pas dans ce délai, le contrôle de santé échoue. Valeurs valides : 1 à 300. Remarque Ce paramètre prend effet uniquement lorsque HealthCheckEnabled est défini sur true.	3
HealthyThreshold	integer	Non	Le nombre de contrôles de santé réussis consécutifs requis pour que l'état d'un serveur passe de fail à success. Valeurs valides : 2 à 10.	4
UnhealthyThreshold	integer	Non	Le nombre de contrôles de santé échoués consécutifs requis pour que l'état d'un serveur passe de success à fail. Valeurs valides : 2 à 10.	4
StickySessionConfig	object	Non	Les paramètres de session persistante.
Cookie	string	Non	Le cookie configuré sur le serveur. Le cookie doit comporter de 1 à 200 caractères et être composé de caractères ASCII. 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 uniquement lorsque StickySessionEnabled est défini sur true et StickySessionType est défini sur Server.	B490B5EBF6F3CD402E515D22B******
CookieTimeout	integer	Non	Le délai d'expiration du cookie, en secondes. Valeurs valides : 1 à 86400. Remarque Ce paramètre prend effet uniquement lorsque StickySessionEnabled est défini sur true et StickySessionType est défini sur Insert.	1000
StickySessionEnabled	boolean	Non	Indique si les sessions persistantes doivent être activées. Valeurs valides : true : active les sessions persistantes. false : désactive les sessions persistantes.	false
StickySessionType	string	Non	La méthode utilisée pour gérer les cookies. Valeurs valides : Insert : l'équilibreur de charge insère un cookie (SERVERID) dans la réponse HTTP ou HTTPS à la première requête d'un client. Les requêtes ultérieures du client qui contiennent ce cookie sont acheminées vers le même serveur backend. Server : l'équilibreur de charge écrase le cookie d'origine lorsqu'il détecte un cookie défini par l'utilisateur. Les requêtes ultérieures du client qui contiennent le nouveau cookie sont acheminées vers le même serveur backend. Remarque Ce paramètre prend effet uniquement lorsque StickySessionEnabled est défini sur true.	Insert
ServerGroupId	string	Oui	L'identifiant du groupe de serveurs.	sgp-atstuj3rtop****
UpstreamKeepaliveEnabled	boolean	Non	Indique si les connexions persistantes vers les serveurs backend doivent être activées. true : active les connexions persistantes. false : désactive les connexions persistantes.	sgp-123
ServiceName	string	Non	Le nom du Service Kubernetes (K8s) correspondant. Ce paramètre s'applique uniquement aux scénarios Ingress d'Application Load Balancer (ALB).	test2
UchConfig	object	Non	Les paramètres de hachage cohérent basé sur l'URL.
Type	string	Oui	Le type du paramètre. Seul QueryString est pris en charge.	QueryString
Value	string	Oui	Le nom du paramètre de chaîne de requête à utiliser pour le hachage cohérent.	abc
ConnectionDrainConfig	object	Non	Les paramètres de vidage des connexions. Si le vidage des connexions est activé, l'équilibreur de charge permet aux connexions existantes d'être traitées pendant une période spécifiée après la suppression d'un serveur backend ou sa déclaration comme non sain. Remarque Les instances de base ne prennent pas en charge le vidage des connexions. Seules les instances Standard et améliorées par WAF prennent en charge cette fonctionnalité. Les groupes de serveurs de type instance et 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 : active le vidage des connexions. false : désactive le vidage des connexions.	false
ConnectionDrainTimeout	integer	Non	Le délai d'attente du vidage des connexions, en secondes. Valeurs valides : 0 à 900.	300
SlowStartConfig	object	Non	Les paramètres de démarrage lent. Si vous activez le démarrage lent, l'équilibreur de charge prépare un serveur backend nouvellement ajouté sur une période spécifiée. Pendant cette période de préparation, le nombre de requêtes acheminées vers le serveur augmente de manière linéaire. Remarque Les instances de base ne prennent pas en charge le démarrage lent. Seules les instances Standard et améliorées par WAF prennent en charge cette fonctionnalité. Les groupes de serveurs de type instance et IP prennent en charge le démarrage lent. Les groupes de serveurs de type Function Compute ne le prennent pas en charge. Le démarrage lent ne peut être activé que lorsque l'algorithme de planification est le tourniquet pondéré.
SlowStartEnabled	boolean	Non	Indique si le démarrage lent doit être activé. true : active le démarrage lent. false : désactive le démarrage lent.	false
SlowStartDuration	integer	Non	La durée de la période de démarrage lent, en secondes. Valeurs valides : 30 à 900.	30
CrossZoneEnabled	boolean	Non	Indique si l'équilibrage de charge inter-zones doit être activé pour le groupe de serveurs. Valeurs valides : true (par défaut) : active l'équilibrage de charge inter-zones. false : désactive l'équilibrage de charge inter-zones. Remarque Les instances de base nécessitent l'activation de l'équilibrage de charge inter-zones. L'option de le désactiver n'est prise en charge que par les instances Standard et améliorées par WAF. Les groupes de serveurs de type instance et IP prennent en charge la désactivation de l'équilibrage de charge inter-zones. Les groupes de serveurs de type Function Compute ne le prennent pas en charge. Les sessions persistantes ne peuvent pas être activées lorsque l'équilibrage de charge inter-zones est désactivé.	true
IpVersionAffinityMode	string	Non	Le mode d'affinité de la version IP.	Affinity

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les données de 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-7FF3*****

Exemples

JSON format

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

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	IncorrectStatus.ServerGroup	The status of %s [%s] is incorrect.	The status of %s [%s] is incorrect.
400	Mismatch.LoadBalancerEditionAndConnectionDrain	The %s and %s are mismatched.	The %s and %s are mismatched.
400	Mismatch.ServerGroupSchedulerAndSlowStartEnable	The %s and %s are mismatched.	The %s and %s are mismatched.
400	QuotaExceeded.ConnectionDrainTimeout	The quota of %s is exceeded, usage %s/%s.	The quota of %s is exceeded, usage %s/%s.
400	UnsupportedFeature.ConnectionDrain	The feature of %s is not supported.	The feature of %s is not supported.
400	QuotaExceeded.SlowStartDuration	The quota of %s is exceeded, usage %s/%s.	The quota of %s is exceeded, usage %s/%s.
400	UnsupportedFeature.SlowStart	The feature of %s is not supported.
400	Mismatch.LoadBalancerEditionAndSlowStartEnable	The %s and %s are mismatched.	The %s and %s are mismatched.
400	OperationDenied.UpstreamKeepaliveDisabled	The operation is not allowed because of UpstreamKeepaliveDisabled.	Updating not allowed Backend long connection is closed
400	OperationDenied.UpstreamKeepaliveEnabled	The operation is not allowed because of UpstreamKeepaliveEnabled.	Update not allowed to open Backend Long connection is in the open state
400	CloseUpstreamKeepaliveNotSupport	The param of UpstreamKeepalive is not Support.	close keepalive attribute for server group is not supported
404	ResourceNotFound.ServerGroup	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.