UpdateServerGroupAttribute - - Centre de documentation Alibaba Cloud

Met à jour la configuration d'un groupe de serveurs Network Load Balancer (NLB).

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.

nlb:UpdateServerGroupAttribute

update

*ServerGroup.

acs:nlb:{#regionId}:{#accountId}:servergroup/{#ServerGroupId}

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 nouveau nom du groupe de serveurs. Le nom doit comporter de 2 à 128 caractères et commencer par une lettre ou un caractère chinois. Il peut contenir des chiffres, des points (.), des traits de soulignement (_) et des traits d'union (-).	NLB_ServerGroup1
ConnectionDrainEnabled	boolean	Non	Indique si le vidage des connexions doit être activé. Valeurs valides : true : active le vidage des connexions. false : désactive le vidage des connexions.	false
ConnectionDrainTimeout	integer	Non	Le délai d'attente pour le vidage des connexions. Unité : secondes. Valeurs valides : 0 à 900.	10
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 : connexions les moins nombreuses 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 deux serveurs backend ont le même poids, le serveur backend avec le moins de connexions reçoit davantage de requêtes. rr : tourniquet. Les requêtes sont distribuées aux serveurs backend de manière séquentielle. sch : hachage d'IP source. Les requêtes provenant de la même adresse IP source sont distribuées au même serveur backend. tch : hachage de quadruplet. Hachage cohérent basé sur le quadruplet (adresse IP source, adresse IP de destination, port source et port de destination). Les requêtes provenant du même flux sont distribuées au même serveur backend. qch : hachage d'identifiant QUIC. Les requêtes avec le même identifiant QUIC sont distribuées au même serveur backend. Remarque Le hachage d'identifiant QUIC n'est pris en charge que lorsque le protocole backend est UDP.	Wrr
IpVersionAffinityMode	string	Non	La stratégie de planification du trafic en mode double pile. Valeurs valides : NonAffinity (par défaut) : mode sans affinité. Les requêtes sont transmises aux serveurs backend sains en fonction de l'algorithme de planification, quelle que soit la version du protocole IP de la source. Affinity : mode avec affinité. Les requêtes sont transmises en fonction de la version du protocole IP de la source. Les requêtes IPv4 sont transmises uniquement aux serveurs backend IPv4, et les requêtes IPv6 sont transmises uniquement aux serveurs backend IPv6. Remarque Ce paramètre ne prend effet que lorsque AddressIPVersion est défini sur DualStack.	Affinity
PreserveClientIpEnabled	boolean	Non	Indique si la préservation de l'adresse IP du client doit être activée. Valeurs valides : true : active la préservation de l'adresse IP du client. false : désactive la préservation de l'adresse IP du client. Remarque Si PreserveClientIpEnabled est défini sur false et que le groupe de serveurs est associé à un écouteur TCPSSL, vous ne pouvez pas changer la valeur de ce paramètre en true.	false
HealthCheckConfig	object	Non	La configuration du bilan de santé.
HealthCheckConnectPort	integer	Non	Le port du serveur backend utilisé pour les bilans de santé. Valeurs valides : 0 à 65535. Une valeur de 0 indique que le port du serveur backend est utilisé pour les bilans de santé.	0
HealthCheckConnectTimeout	integer	Non	Le délai d'attente maximum pour une réponse de bilan de santé. Unité : secondes. Valeurs valides : 1 à 300. Valeur par défaut : 5.	100
HealthCheckDomain	string	Non	Le nom de domaine utilisé pour les bilans de santé. Valeurs valides : $SERVER_IP : l'adresse IP interne du serveur backend. domain : un nom de domaine personnalisé. Le nom de domaine doit comporter de 1 à 80 caractères et ne peut contenir que des lettres minuscules, des chiffres, des traits d'union (-) et des points (.). Remarque Ce paramètre ne prend effet que lorsque HealthCheckType est défini sur HTTP.	$SERVER_IP
HealthCheckEnabled	boolean	Non	Indique si les bilans de santé doivent être activés. Valeurs valides : true : active les bilans de santé. false : désactive les bilans de santé.	false
HealthCheckExp	string	Non	La chaîne de réponse pour les bilans de santé des écouteurs UDP. La chaîne ne peut contenir que des lettres et des chiffres, et peut comporter jusqu'à 512 caractères.	ok
HealthCheckHttpCode	array	Non	Les codes d'état HTTP pour les réponses saines. Séparez plusieurs codes d'état HTTP par des virgules (,). Valeurs valides : http_2xx (par défaut), http_3xx, http_4xx et http_5xx. Remarque Ce paramètre ne prend effet que lorsque HealthCheckType est défini sur HTTP.
	string	Non	Les codes d'état HTTP pour les réponses saines. Séparez plusieurs codes d'état HTTP par des virgules (,). Valeurs valides : http_2xx (par défaut), http_3xx, http_4xx et http_5xx. Remarque Ce paramètre ne prend effet que lorsque HealthCheckType est défini sur HTTP.	http_2xx
HealthCheckHttpVersion	string	Non	La version du protocole HTTP pour les bilans de santé. Valeurs valides : HTTP1.0 et HTTP1.1. Remarque Ce paramètre ne prend effet que lorsque HealthCheckType est défini sur HTTP.	HTTP1.0
HealthCheckInterval	integer	Non	L'intervalle entre deux bilans de santé consécutifs. Unité : secondes. Valeur par défaut : 5. Si HealthCheckType est défini sur TCP ou HTTP, les valeurs valides sont de 1 à 50. Si HealthCheckType est défini sur UDP, les valeurs valides sont de 1 à 300. L'intervalle doit être supérieur ou égal au délai d'attente de réponse pour garantir que les réponses de sonde UDP ne soient pas considérées à tort comme une absence de réponse en raison d'un délai d'attente dépassé.	5
HealthCheckReq	string	Non	La chaîne de requête pour les bilans de santé des écouteurs UDP. La chaîne ne peut contenir que des lettres et des chiffres, et peut comporter jusqu'à 512 caractères.	hello
HealthCheckType	string	Non	Le protocole utilisé pour les bilans de santé. Valeurs valides : TCP HTTP UDP	TCP
HealthCheckUrl	string	Non	Le chemin du bilan 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 `_;~!()[]@$^:',+`. Il doit commencer par une barre oblique (/). Remarque* Ce paramètre ne prend effet que lorsque HealthCheckType est défini sur HTTP.	/test/index.html
HealthyThreshold	integer	Non	Le nombre de bilans de santé réussis consécutifs requis pour faire passer l'état du bilan de santé d'un serveur backend de Failed à Successful. Valeurs valides : 2 à 10.	3
HttpCheckMethod	string	Non	La méthode HTTP utilisée pour les bilans de santé. Valeurs valides : GET et HEAD. Remarque Ce paramètre ne prend effet que lorsque HealthCheckType est défini sur HTTP.	GET
UnhealthyThreshold	integer	Non	Le nombre de bilans de santé échoués consécutifs requis pour faire passer l'état du bilan de santé d'un serveur backend de Successful à Failed. Valeurs valides : 2 à 10.	3
RegionId	string	Non	L'identifiant de la région de l'instance Network Load Balancer (NLB). Vous pouvez appeler l'opération DescribeRegions pour obtenir l'identifiant de la région.	cn-hangzhou
DryRun	boolean	Non	Indique si un test à blanc doit être effectué. Valeurs valides : true : effectue un test à blanc et ne met pas à jour le groupe de serveurs. 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, 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 le jeton, mais vous devez vous assurer que le jeton 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 automatiquement le RequestId de la requête API comme ClientToken. Le RequestId de chaque requête API est unique.	123e4567-e89b-12d3-a456-426655440000

Éléments de réponse

Élément	Type	Description	Exemple
	object	La configuration du groupe de serveurs.
JobId	string	L'identifiant de la tâche asynchrone.	72dcd26b-f12d-4c27-b3af-18f6aed5****
RequestId	string	L'identifiant de la requête.	54B48E3D-DF70-471B-AA93-08E683A1B45
ServerGroupId	string	L'identifiant du groupe de serveurs.	sgp-atstuj3rtoptyui****

Exemples

JSON format

{
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "ServerGroupId": "sgp-atstuj3rtoptyui****"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	IllegalParam.%s	The param of %s is illegal.	Le paramètre %s n'est pas valide.
400	SystemBusy	System is busy, please try again later.	Le système est occupé. Réessayez ultérieurement.
400	IllegalParam.healthCheckDomain	The parameter of healthCheckConfig.healthCheckDomain is illegal.	Le healthCheckDomain dans la configuration de la vérification de l'état n'est pas valide. Vérifiez les paramètres d'entrée.
400	IlleagalParam.healthCheckUrl	The parameter of healthCheckUrl in healthCheckConfig is illegal.	L'URL de vérification de l'état utilisée dans les paramètres de vérification de l'état n'est pas valide.
400	OperationDenied.UidNotAllowQuic29	The operation is not allowed because of uid not allow quic29 version.
400	IllegalParam	The param of %s is illegal.	Les paramètres d'entrée contiennent des valeurs non valides. Vérifiez les données d'entrée.
400	DryRunOperation	Request validation has been passed with DryRun flag set.	La requête DryRun a réussi la validation.
400	IllegalParam.ServerGroupName	The param of ServerGroupName is illegal.	Le paramètre ServerGroupName n'est pas valide.
400	IllegalParam.PreserveClientIpSwitch	The server group associated with the tcpssl listener does not support enabling PreserveClientIp.	Le groupe de serveurs associé à l'écouteur TCPSSL ne prend pas en charge la fonctionnalité de préservation de l'adresse IP du client.
403	Forbidden.NoPermission	Authentication is failed for NoPermission.	L'authentification a échoué car le compte ne dispose pas des autorisations requises.
404	ResourceNotFound.serverGroup	The specified resource of serverGroup is not found.	La ressource de groupe de serveurs spécifiée est introuvable. Vérifiez les paramètres d'entrée.

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

Notes de version

Consultez Notes de version pour la liste complète.