UpdateServerGroupAttribute - - Centre de documentation Alibaba Cloud

Met à jour les configurations d'un groupe de serveurs, telles que les contrôles d'état de santé, la persistance de session, le nom, l'algorithme de planification et le protocole.

Description de l'opération

L'opération UpdateServerGroupAttribute est asynchrone. Après l'envoi de la requête, le système renvoie un identifiant de requête, mais les configurations du groupe de serveurs ne sont pas immédiatement mises à jour. La tâche de mise à jour s'exécute toujours en arrière-plan. Vous pouvez appeler l'opération ListServerGroups pour interroger l'état de mise à jour des configurations du groupe de serveurs :

Si les configurations du groupe de serveurs sont dans l'état Configuring, les configurations sont en cours de mise à jour.
Si les configurations du groupe de serveurs sont dans l'état Available, les configurations sont mises à 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.

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 et commencer par une lettre ou un chiffre. Il 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 davantage de requêtes. Wlc : moindres connexions pondérées. Les requêtes sont distribuées en fonction des poids et des charges réelles (nombre de connexions) des serveurs backend. Si les poids sont identiques, les serveurs backend avec le moins de connexions reçoivent davantage de requêtes. Sch : hachage cohérent. Les requêtes avec le même facteur de hachage sont planifiées vers le même serveur backend. 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 backend. 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 backend.	Wrr
ClientToken	string	Non	Le jeton client utilisé pour garantir l'idempotence de la requête. Vous pouvez utiliser le client pour générer la valeur, mais vous devez vous assurer que la valeur 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 le RequestId de la requête API comme jeton client. Le RequestId de chaque requête API peut être différent.	5A2CFF0E-5718-45B5-9D4D-70B3******
DryRun	boolean	Non	Indique si un test à blanc doit être effectué. Valeurs valides : true : effectue un test à blanc sans modifier les ressources. Le système vérifie si les paramètres requis sont spécifiés, si le format de la requête est valide et si les limites de service sont respectées. Si la requête échoue au test à blanc, une erreur est renvoyée. 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.	true
HealthCheckConfig	object	Non	Les configurations de contrôle d'état de santé.	true
HealthCheckCodes	array	Non	La liste des codes d'état qui indiquent la réussite d'un contrôle d'état de santé.
	string	Non	Les codes d'état qui indiquent la réussite d'un contrôle d'état de santé. Si 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 (,). Si HealthCheckProtocol est défini sur gRPC, les valeurs valides pour HealthCheckCodes vont de 0 à 99. Valeur par défaut : 0. Vous pouvez spécifier des plages. Un maximum de 20 plages sont prises en charge. Séparez plusieurs plages par des virgules (,). Remarque Ce paramètre prend effet uniquement lorsque HealthCheckEnabled est défini sur true et que HealthCheckProtocol est défini sur HTTP, HTTPS ou gRPC pour le groupe de serveurs.	200
HealthCheckConnectPort	integer	Non	Le port du serveur backend utilisé pour les contrôles d'état de santé. Valeurs valides : 0 à 65535. Une valeur de 0 indique que le port du serveur backend est utilisé pour les contrôles d'état de santé. Remarque Les paramètres ne prennent effet que lorsque HealthCheckEnabled est défini sur true pour le groupe de serveurs.	80
HealthCheckEnabled	boolean	Non	Indique si les contrôles d'état de santé doivent être activés. Valeurs valides : true : active les contrôles d'état de santé. false : désactive les contrôles d'état de santé.	true
HealthCheckHost	string	Non	Le nom de domaine utilisé pour les contrôles d'état de santé. Utiliser l'adresse IP interne du serveur backend (par défaut) : l'adresse IP interne du serveur backend est utilisée comme nom de domaine pour les contrôles d'état de santé. Spécifier un nom de domaine : saisissez un nom de domaine. 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 (.) et ne peut pas commencer ou se terminer par un point (.). Le libellé de domaine le plus à droite ne peut contenir que des lettres et ne peut pas contenir de chiffres ou de traits d'union (-). Il ne peut pas commencer ou se terminer par un trait d'union (-). Remarque Ce paramètre prend effet uniquement lorsque HealthCheckProtocol est défini sur HTTP, HTTPS ou gRPC.	example.com
HealthCheckHttpVersion	string	Non	La version HTTP utilisée pour les contrôles d'état de santé. Valeurs valides : HTTP1.0 HTTP1.1 Remarque Ce paramètre prend effet uniquement lorsque HealthCheckEnabled est défini sur true et que HealthCheckProtocol est défini sur HTTP ou HTTPS pour le groupe de serveurs.	HTTP1.1
HealthCheckInterval	integer	Non	L'intervalle entre deux contrôles d'état de santé consécutifs. Unité : secondes. Valeurs valides : 1 à 50. Remarque Les paramètres ne prennent effet que lorsque HealthCheckEnabled est défini sur true pour le groupe de serveurs.	5
HealthCheckMethod	string	Non	La méthode HTTP utilisée pour les contrôles d'état de santé. Valeurs valides : GET : si la longueur de la réponse dépasse 8 Ko, la réponse est tronquée. Cependant, cela n'affecte pas le résultat du contrôle d'état de santé. POST : par défaut, les écouteurs gRPC utilisent la méthode POST pour les contrôles d'état de santé. HEAD : par défaut, les écouteurs HTTP et HTTPS utilisent la méthode HEAD pour les contrôles d'état de santé. Remarque Ce paramètre prend effet uniquement lorsque HealthCheckEnabled est défini sur true et que HealthCheckProtocol est défini sur HTTP, HTTPS ou gRPC pour le groupe de serveurs.	HEAD
HealthCheckPath	string	Non	Le chemin de la règle de transfert pour les contrôles d'état de santé. Le chemin doit comporter de 1 à 80 caractères. Il ne peut contenir que des lettres, des chiffres, les caractères `-/.%?#&=` et les caractères d'extension `_;~!()[]@$^:',+`. L'URL doit commencer par `/`. Remarque* Ce paramètre prend effet uniquement lorsque HealthCheckEnabled est défini sur true et que HealthCheckProtocol est défini sur HTTP ou HTTPS pour le groupe de serveurs.	/test/index.html
HealthCheckProtocol	string	Non	Le protocole utilisé pour les contrôles d'état de santé. Valeurs valides : HTTP : envoie des requêtes HEAD ou GET pour simuler un accès par navigateur afin de vérifier si l'application serveur est saine. HTTPS : envoie des requêtes HEAD ou GET pour simuler un accès par navigateur afin de vérifier si l'application serveur est saine (chiffrement des données, ce qui rend HTTPS 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	Le délai d'expiration pour accepter une réponse d'un contrôle d'état de santé. Si l'instance ECS backend ne répond pas dans le délai spécifié, le contrôle d'état de santé est considéré comme ayant échoué. Unité : secondes. Valeurs valides : 1 à 300. Remarque Les paramètres ne prennent effet que lorsque HealthCheckEnabled est défini sur true pour le groupe de serveurs.	3
HealthyThreshold	integer	Non	Le nombre de contrôles d'état de santé réussis consécutifs qui doivent se produire avant que l'état de contrôle d'état de santé d'un serveur backend ne passe de fail à success. Valeurs valides : 2 à 10.	4
UnhealthyThreshold	integer	Non	Le nombre de contrôles d'état de santé échoués consécutifs qui doivent se produire avant que l'état de contrôle d'état de santé d'un serveur backend ne passe de success à fail. Valeurs valides : 2 à 10.	4
StickySessionConfig	object	Non	Les configurations de persistance de session.
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 et des chiffres 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 que StickySessionType est défini sur Server pour le groupe de serveurs.	B490B5EBF6F3CD402E515D22B******
CookieTimeout	integer	Non	Le délai d'expiration du cookie. Unité : secondes. Valeurs valides : 1 à 86400. Remarque Ce paramètre prend effet uniquement lorsque StickySessionEnabled est défini sur true et que StickySessionType est défini sur Insert pour le groupe de serveurs.	1000
StickySessionEnabled	boolean	Non	Indique si la persistance de session doit être activée. Valeurs valides : true : oui. false : non.	false
StickySessionType	string	Non	La méthode utilisée pour traiter les cookies. Valeurs valides : Insert : insère un cookie. Lorsqu'un client accède au serveur pour la première fois, l'équilibreur de charge insère un cookie (SERVERID) dans la réponse HTTP ou HTTPS. La prochaine fois que le client accède au serveur avec ce cookie, l'équilibreur de charge transfère la requête au serveur backend précédemment enregistré. Server : réécrit un cookie. Lorsque l'équilibreur de charge détecte un cookie défini par l'utilisateur, il réécrit le cookie d'origine. La prochaine fois que le client accède au serveur avec le nouveau cookie, l'équilibreur de charge transfère la requête au serveur backend précédemment enregistré. Remarque Ce paramètre prend effet uniquement lorsque StickySessionEnabled est défini sur true pour le groupe de serveurs.	Insert
ServerGroupId	string	Oui	L'identifiant du groupe de serveurs.	sgp-atstuj3rtop****
UpstreamKeepaliveEnabled	boolean	Non	Indique si le maintien de connexion doit être activé pour les connexions backend. true : active le maintien de connexion. false : désactive le maintien de connexion.	false
ServiceName	string	Non	Le nom du K8s Service qui correspond au groupe de serveurs. Ce paramètre s'applique uniquement aux scénarios ALB Ingress.	test2
UchConfig	object	Non	Les paramètres pour le hachage cohérent d'URL.
Type	string	Oui	Le type du paramètre. Seul QueryString est pris en charge.	QueryString
Value	string	Oui	La valeur du paramètre de hachage cohérent.	abc
ConnectionDrainConfig	object	Non	Les configurations pour la vidange des connexions. Une fois la vidange des connexions activée, l'équilibreur de charge permet aux connexions existantes de maintenir une transmission normale pendant une période spécifiée après la suppression d'un serveur backend ou l'échec du contrôle d'état de santé. Remarque Les instances de l'édition de base ne prennent pas en charge la vidange des connexions. Seules les instances de l'édition standard et de l'édition améliorée WAF prennent en charge cette fonctionnalité. Les groupes de serveurs de type serveur et de type IP prennent en charge la vidange des connexions. Les groupes de serveurs de type Function Compute ne prennent pas en charge cette fonctionnalité.
ConnectionDrainEnabled	boolean	Non	Indique si la vidange des connexions doit être activée. true : active la vidange des connexions. false : désactive la vidange des connexions.	false
ConnectionDrainTimeout	integer	Non	Le délai d'expiration pour la vidange des connexions. Valeurs valides : 0 à 900.	300
SlowStartConfig	object	Non	Les configurations pour le démarrage lent. Une fois le démarrage lent activé, ALB préchauffe les serveurs backend nouvellement ajoutés dans le groupe de serveurs backend pendant une période spécifiée. Le nombre de requêtes transférées aux serveurs backend nouvellement ajoutés 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 améliorée WAF prennent en charge cette fonctionnalité. Les groupes de serveurs de type serveur et de type IP prennent en charge le démarrage lent. Les groupes de serveurs de type Function Compute ne prennent pas en charge cette fonctionnalité. Le démarrage lent ne peut être activé que lorsque l'algorithme de planification backend est le tourniquet pondéré.
SlowStartDuration	integer	Non	La durée de la période de démarrage lent. Valeurs valides : 30 à 900.	30
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
CrossZoneEnabled	boolean	Non	Indique si l'équilibrage de charge interzones doit être activé pour le groupe de serveurs. Valeurs valides : true : active l'équilibrage de charge interzones. Il s'agit de la valeur par défaut. false : désactive l'équilibrage de charge interzones. Remarque Les instances de l'édition de base ne prennent pas en charge les groupes de serveurs avec l'équilibrage de charge interzones désactivé. Seules les instances de l'édition standard et de l'édition améliorée WAF 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 interzones. Les groupes de serveurs de type Function Compute ne prennent pas en charge cette fonctionnalité. La persistance de session ne peut pas être activée lorsque l'équilibrage de charge interzones 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 données 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-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.	L'état du groupe de serveurs n'est pas valide.
400	Mismatch.LoadBalancerEditionAndConnectionDrain	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.ConnectionDrainTimeout	The quota of %s is exceeded, usage %s/%s.	Le paramètre %s dépasse la limite de quota. La valeur actuelle est de %s et la valeur du quota est de %s.
400	UnsupportedFeature.ConnectionDrain	The feature of %s is not supported.	La fonctionnalité %s n'est pas prise en charge.
400	QuotaExceeded.SlowStartDuration	The quota of %s is exceeded, usage %s/%s.	Le paramètre %s dépasse la limite de quota. La valeur actuelle est de %s et la valeur du quota est de %s.
400	UnsupportedFeature.SlowStart	The feature of %s is not supported.	La fonctionnalité %s n'est pas prise en charge.
400	Mismatch.LoadBalancerEditionAndSlowStartEnable	The %s and %s are mismatched.	Les paramètres %s et %s ne correspondent pas.
400	OperationDenied.UpstreamKeepaliveDisabled	The operation is not allowed because of UpstreamKeepaliveDisabled.	La désactivation des connexions persistantes backend n'est pas autorisée.
400	OperationDenied.UpstreamKeepaliveEnabled	The operation is not allowed because of UpstreamKeepaliveEnabled.	La mise à jour des connexions persistantes backend vers l'état activé n'est pas autorisée.
400	CloseUpstreamKeepaliveNotSupport	The param of UpstreamKeepalive is not Support.	La désactivation des connexions persistantes backend pour le groupe de serveurs n'est pas prise en charge.
400	OperationDenied.VpcNotSupportIpv6	The operation is not allowed because of VpcNotSupportIpv6.	L'opération n'est pas autorisée car IPv6 n'est pas activé pour le VPC actuel.
400	OperationDenied.Ipv6ServerExists	IPv6 backend servers exist in the specified server group.	Le groupe de serveurs contient des serveurs backends IPv6 et ne peut pas être modifié en IPv4.
404	ResourceNotFound.ServerGroup	The specified resource %s is not found.	Le groupe de serveurs backend n'existe pas.

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

Notes de version

Consultez Notes de version pour la liste complète.