UpdateHealthCheckTemplateAttribute - - Centre de documentation Alibaba Cloud

Cette opération met à jour les attributs d'un modèle de vérification de l'état, tels que son nom et le protocole de vérification de l'état.

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

update

*HealthCheckTemplate

acs:alb:{#regionId}:{#accountId}:healthchecktemplate/{#healthchecktemplateId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
ClientToken	string	Non	Un jeton client utilisé pour garantir l'idempotence de la requête. Vous devez générer une valeur unique sur votre client 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 comme `ClientToken`. Le `RequestId` de chaque requête est unique.	5A2CFF0E-5718-45B5-9D4D-70B******
HealthCheckTemplateName	string	Non	Le nom du modèle de vérification de l'état. Le nom doit comporter de 2 à 128 caractères, commencer par une lettre, un caractère chinois ou un chiffre, et peut contenir des lettres, des caractères chinois, des chiffres, des points (.), des traits de soulignement (_), des traits d'union (-) et des espaces.	HealthCheckTemplate1
HealthCheckConnectPort	integer	Non	Le port utilisé pour les vérifications de l'état. Valeurs valides : 0 à 65535. La valeur par défaut est 0, ce qui signifie que la vérification de l'état utilise le port du serveur backend.	80
HealthCheckHost	string	Non	Le nom de domaine utilisé pour les vérifications de l'état. Valeurs valides : $SERVER_IP (par défaut) : L'adresse IP privée d'un serveur backend. Si vous spécifiez cette valeur ou laissez le paramètre vide, le service d'équilibrage de charge utilise l'adresse IP privée du serveur backend pour les vérifications de l'état. domain : Un nom de domaine comportant de 1 à 80 caractères et pouvant contenir des lettres, des chiffres, des points (.) et des traits d'union (-). Remarque Ce paramètre prend effet uniquement lorsque le paramètre `HealthCheckProtocol` est défini sur HTTP ou HTTPS.	$SERVER_IP
HealthCheckCodes	array	Non	La liste des codes d'état qui indiquent un état sain.	5
	string	Non	Les codes d'état HTTP qui indiquent qu'un serveur backend est sain. Si HealthCheckProtocol est défini sur HTTP ou HTTPS, spécifiez une ou plusieurs des valeurs suivantes : http_2xx (par défaut), http_3xx, http_4xx et http_5xx. Séparez les valeurs multiples par des virgules. Si HealthCheckProtocol est défini sur gRPC, les codes d'état valides se situent dans la plage de 0 à 99. La valeur par défaut est 0. Vous pouvez spécifier jusqu'à 20 plages, séparées par des virgules. Remarque Ce paramètre prend effet uniquement lorsque le paramètre HealthCheckProtocol est défini sur HTTP, HTTPS ou gRPC.	http_2xx
HealthCheckInterval	integer	Non	L'intervalle entre les vérifications de l'état, en secondes. Valeurs valides : 1 à 50. Valeur par défaut : 2.	5
HealthCheckTimeout	integer	Non	Le délai d'attente, en secondes, pour une réponse de vérification de l'état. Une vérification de l'état échoue si un serveur backend ne répond pas dans ce délai. Valeurs valides : 1 à 300. Valeur par défaut : 5.	3
HealthCheckPath	string	Non	L'URL utilisée pour les vérifications de l'état. L'URL doit comporter de 1 à 80 caractères. Elle peut contenir des lettres, des chiffres, des traits d'union (-), des barres obliques (/), des points (.), des signes de pourcentage (%), des points d'interrogation (?), des croisillons (#), des esperluettes (&) et les caractères étendus suivants : `_;~!()[]@$^:',+`. L'URL doit commencer par une barre oblique (/). Remarque* Ce paramètre prend effet uniquement lorsque le paramètre HealthCheckProtocol est défini sur HTTP, HTTPS ou gRPC.	/test/index.html
HealthCheckMethod	string	Non	La méthode utilisée pour les vérifications de l'état. Valeurs valides : HEAD (par défaut) : La méthode par défaut pour les vérifications de l'état sur les écouteurs HTTP et HTTPS. GET : Si le corps de la réponse dépasse 8 Ko, il est tronqué. Cela n'affecte pas le résultat de la vérification de l'état. POST : La méthode par défaut pour les vérifications de l'état sur les écouteurs gRPC. Remarque Ce paramètre prend effet uniquement lorsque le paramètre HealthCheckProtocol est défini sur HTTP, HTTPS ou gRPC.	HEAD
HealthCheckProtocol	string	Non	Le protocole utilisé pour les vérifications de l'état. Valeurs valides : HTTP (par défaut) : Vérifie l'état d'un serveur backend en envoyant une requête HTTP HEAD ou GET. HTTPS : Vérifie l'état d'un serveur backend en envoyant une requête HTTPS HEAD ou GET. HTTPS est plus sécurisé que HTTP car il chiffre les données. TCP : Vérifie si un port de serveur backend est accessible en envoyant un paquet TCP SYN. gRPC : Vérifie l'état d'un serveur backend en envoyant une requête POST ou GET.	HTTP
HealthCheckHttpVersion	string	Non	La version HTTP utilisée pour les vérifications de l'état. Valeurs valides : HTTP1.0 et HTTP1.1. Valeur par défaut : HTTP1.1. Remarque Ce paramètre prend effet uniquement lorsque le paramètre `HealthCheckProtocol` est défini sur HTTP ou HTTPS.	HTTP1.0
HealthyThreshold	integer	Non	Le nombre de vérifications de l'état réussies et consécutives requises pour faire passer l'état d'un serveur backend de non sain à sain. Valeurs valides : 2 à 10. Valeur par défaut : 3.	4
UnhealthyThreshold	integer	Non	Le nombre de vérifications de l'état échouées et consécutives requises pour faire passer l'état d'un serveur backend de sain à non sain. Valeurs valides : 2 à 10. Valeur par défaut : 3.	4
DryRun	boolean	Non	Indique si un test à blanc doit être effectué. Valeurs valides : true : Effectue un test à blanc pour vérifier la requête. Le système vérifie les paramètres requis, la syntaxe de la requête et les contraintes métier sans exécuter l'opération. Si la requête n'est pas valide, une erreur est renvoyée. Si la requête est valide, le code d'erreur `DryRunOperation` est renvoyé. false (par défaut) : Envoie une requête normale. Si la requête est valide, un code d'état HTTP 2xx est renvoyé et l'opération est exécutée.	true
HealthCheckTemplateId	string	Oui	L'identifiant du modèle de vérification de l'état.	hct-bp1qjwo61******

Éléments de réponse

Élément	Type	Description	Exemple
	object	La réponse à la requête de mise à jour.
RequestId	string	L'identifiant de la requête.	365F4154-92F6-4AE4-92F8-7FF3******

Exemples

JSON format

{
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF3******"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	IncorrectStatus.HealthCheckTemplate	The status of %s [%s] is incorrect.	The status of %s [%s] is incorrect.
403	Forbidden.HealthCheckTemplate	Authentication is failed for %s.	Authentication is failed for %s.
404	ResourceNotFound.HealthCheckTemplate	The specified resource %s is not found.	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.