Tous les produits
Search
Centre de documentation

:UpdateServerGroupAttribute

Dernière mise à jour :Aug 18, 2026

Modifie la configuration d'un groupe de serveurs pour Network Load Balancer (NLB).

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'appeler cette opération dans OpenAPI Explorer, qui génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

ParamètreTypeObligatoireExempleDescription
ActionStringOuiUpdateServerGroupAttribute

Opération à effectuer. Définissez la valeur sur UpdateServerGroupAttribute.

ServerGroupIdStringOuisgp-atstuj3rtoptyui****

ID du groupe de serveurs.

ServerGroupNameStringNonNLB_ServerGroup1

Nouveau nom du groupe de serveurs.

Le nom doit comporter entre 2 et 128 caractères et peut contenir des lettres, des chiffres, des points (.), des traits de soulignement (_) et des traits d'union (-). Il doit commencer par une lettre.

ConnectionDrainEnabledBooleanNonfalse

Indique si le vidage de connexion est activé. Valeurs possibles :

  • true : active le vidage de connexion.
  • false : désactive le vidage de connexion.
ConnectionDrainTimeoutIntegerNon10

Délai d'expiration du vidage de connexion, en secondes. Valeurs possibles : 10 à 900.

SchedulerStringNonWrr

Algorithme de planification. Valeurs possibles :

  • Wrr : les serveurs backend avec des poids plus élevés reçoivent plus de requêtes que ceux avec des poids plus faibles.
  • rr : les requêtes sont transférées aux serveurs backend de manière séquentielle.
  • sch : les requêtes provenant de la même adresse IP source sont transférées vers le même serveur backend.
  • tch : utilise un hachage cohérent basé sur quatre facteurs (adresse IP source, adresse IP de destination, port source et port de destination). Les requêtes partageant les mêmes valeurs pour ces quatre facteurs sont transférées vers le même serveur backend.
  • qch : les requêtes contenant le même ID QUIC sont transférées vers le même serveur backend.
PreserveClientIpEnabledBooleanNonfalse

Indique si la préservation de l'adresse IP client est activée. Valeurs possibles :

  • true : active la préservation de l'adresse IP client.
  • false : désactive la préservation de l'adresse IP client.
HealthCheckConfig.HealthCheckEnabledBooleanNonfalse

Indique si la fonction de contrôle de santé est activée. Valeurs possibles :

  • true : active la fonction de contrôle de santé.
  • false : désactive la fonction de contrôle de santé.
HealthCheckConfig.HealthCheckTypeStringNonTCP

Protocole utilisé pour les contrôles de santé. Valeurs possibles : TCP et HTTP.

HealthCheckConfig.HealthCheckConnectPortIntegerNon0

Port backend utilisé pour les contrôles de santé. Valeurs possibles : 0 à 65535. Si la valeur est définie sur 0, les ports des serveurs backend sont utilisés pour les contrôles de santé.

HealthCheckConfig.HealthyThresholdIntegerNon3

Nombre de contrôles de santé consécutifs qu'un serveur backend non sain doit réussir pour être déclaré sain. Dans ce cas, l'état de santé passe de fail à success. Valeurs possibles : 2 à 10.

HealthCheckConfig.UnhealthyThresholdIntegerNon3

Nombre de contrôles de santé consécutifs qu'un serveur backend sain doit échouer pour être déclaré non sain. Dans ce cas, l'état de santé passe de success à fail. Valeurs possibles : 2 à 10.

HealthCheckConfig.HealthCheckConnectTimeoutIntegerNon100

Délai d'expiration maximal d'une réponse de contrôle de santé, en secondes. Valeurs possibles : 1 à 300.

HealthCheckConfig.HealthCheckIntervalIntegerNon5

Intervalle entre deux contrôles de santé consécutifs, en secondes.

Valeurs possibles : 5 à 50.

HealthCheckConfig.HealthCheckDomainStringNon$SERVER_IP

Nom de domaine utilisé pour les contrôles de santé. Valeurs possibles :

  • $SERVER_IP : adresse IP privée d'un serveur backend.
  • domain : nom de domaine spécifique. Le nom de domaine doit comporter entre 1 et 80 caractères et peut contenir des lettres minuscules, des chiffres, des traits d'union (-) et des points (.).
Remarque Ce paramètre prend effet uniquement lorsque HealthCheckType est défini sur HTTP.
HealthCheckConfig.HealthCheckUrlStringNon/test/index.html

Chemin vers lequel les requêtes de contrôle de santé sont envoyées.

Le chemin doit comporter entre 1 et 80 caractères et ne peut contenir que des lettres, des chiffres et les caractères spéciaux suivants : - / . % ? # & =. Il peut également contenir les caractères étendus suivants : _ ; ~ ! ( ) * [ ] @ $ ^ : ' , +. Le chemin doit commencer par une barre oblique (/).

Remarque Ce paramètre prend effet uniquement lorsque HealthCheckType est défini sur HTTP.
HealthCheckConfig.HealthCheckHttpCode.NStringNonhttp_2xx

Codes d'état HTTP à renvoyer pour les contrôles de santé. Séparez plusieurs codes par des virgules (,).

Valeurs possibles : http_2xx (par défaut), http_3xx, http_4xx et http_5xx.

Remarque Ce paramètre prend effet uniquement lorsque HealthCheckType est défini sur HTTP.
HealthCheckConfig.HttpCheckMethodStringNonGET

Méthode HTTP utilisée pour les contrôles de santé. Valeurs possibles : GET et HEAD.

Remarque Ce paramètre prend effet uniquement lorsque HealthCheckType est défini sur HTTP.
RegionIdStringNoncn-hangzhou

ID de la région où l'instance NLB est déployée.

Appelez l'opération DescribeRegions pour interroger les régions disponibles.

DryRunBooleanNonfalse

Indique s'il faut uniquement prévalider la requête. Valeurs possibles :

  • true : vérifie la requête sans exécuter l'opération UpdateServerGroupAttribute. Le système vérifie les paramètres obligatoires, la syntaxe de la requête et les limites. Si la vérification échoue, un message d'erreur est renvoyé. Si elle réussit, le code d'erreur DryRunOperation est renvoyé.
  • false (par défaut) : envoie la requête. Si la vérification réussit, un code d'état HTTP 2xx est renvoyé et l'opération UpdateServerGroupAttribute est exécutée.
ClientTokenStringNon123e4567-e89b-12d3-a456-426655440000

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 qu'elle est unique pour chaque requête. Le jeton ne peut contenir que des caractères ASCII.

Remarque Si vous ne spécifiez pas ce paramètre, le système définit automatiquement ClientToken sur la valeur de RequestId. La valeur de RequestId peut varier pour chaque requête API.

Paramètres de réponse

Paramètre Type Exemple Description
RequestId String 54B48E3D-DF70-471B-AA93-08E683A1B45

ID de la requête.

ServerGroupId String sgp-atstuj3rtoptyui****

ID du groupe de serveurs.

JobId String 72dcd26b-f12d-4c27-b3af-18f6aed5****

ID de la tâche asynchrone.

Exemples

Exemples de requêtes

http(s)://[Endpoint]/?Action=UpdateServerGroupAttribute
&ServerGroupId=sgp-atstuj3rtoptyui****
&ServerGroupName=NLB_ServerGroup1
&ConnectionDrainEnabled=false
&ConnectionDrainTimeout=10
&Scheduler=Wrr
&PreserveClientIpEnabled=false
&HealthCheckConfig={"HealthCheckEnabled":false,"HealthCheckType":"TCP","HealthCheckConnectPort":0,"HealthyThreshold":3,"UnhealthyThreshold":3,"HealthCheckConnectTimeout":100,"HealthCheckInterval":5,"HealthCheckDomain":"$SERVER_IP","HealthCheckUrl":"/test/index.html","HealthCheckHttpCode":["http_2xx"],"HttpCheckMethod":"GET"}
&RegionId=cn-hangzhou
&DryRun=false
&ClientToken=123e4567-e89b-12d3-a456-426655440000
Common request parameters

Exemples de réponses réussies

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateServerGroupAttributeResponse>
    <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>
    <ServerGroupId>sgp-atstuj3rtoptyui****</ServerGroupId>
    <JobId>72dcd26b-f12d-4c27-b3af-18f6aed5****</JobId>
</UpdateServerGroupAttributeResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez les Codes d'erreur de service.