CreateHealthCheckTemplate - - Centre de documentation Alibaba Cloud

Crée un modèle de contrôle de santé dans une région spécifié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:CreateHealthCheckTemplate

create

*HealthCheckTemplate

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
ClientToken	string	Non	Le jeton client utilisé pour garantir l'idempotence de la requête. Vous pouvez générer ce jeton, mais vous devez vous assurer qu'il 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 utilise le `RequestId` de la requête comme jeton client. Chaque requête d'API possède un `RequestId` unique.	5A2CFF0E-5718-45B5-9D4D-70B******
HealthCheckTemplateName	string	Oui	Le nom du modèle de contrôle de santé. Le nom doit comporter de 2 à 128 caractères, commencer par une lettre, un chiffre ou un caractère chinois, et peut contenir des chiffres, des points (.), des traits de soulignement (_), des tirets (-) et des espaces.	HealthCheckTemplate1
HealthCheckConnectPort	integer	Non	Le port utilisé pour les contrôles de santé. Valeurs valides : 0 à 65535. Valeur par défaut : 0. Cette valeur indique que le port d'un serveur back-end est utilisé pour les contrôles de santé.	80
HealthCheckHost	string	Non	Le nom de domaine utilisé pour le contrôle de santé. Valeurs valides : $SERVER_IP : L'adresse IP privée d'un serveur back-end. Si vous définissez ce paramètre sur `$SERVER_IP` ou le laissez vide, l'équilibreur de charge utilise l'adresse IP privée du serveur back-end comme nom de domaine pour le contrôle de santé. domain : Le nom de domaine doit comporter de 1 à 80 caractères et peut contenir des lettres, des chiffres, des points (.) et des tirets (-). Remarque Ce paramètre prend effet uniquement lorsque le paramètre `HealthCheckProtocol` est défini sur HTTP ou HTTPS.	$SERVER_IP
HealthCheckCodes	array	Non	Les codes d'état HTTP qui indiquent qu'un contrôle de santé a réussi.	5
	string	Non	Les codes d'état HTTP qui indiquent qu'un contrôle de santé a réussi. Si HealthCheckProtocol est défini sur HTTP ou HTTPS, vous pouvez spécifier http_2xx (par défaut), http_3xx, http_4xx et http_5xx. Vous pouvez spécifier plusieurs codes d'état HTTP. Séparez-les par des virgules (,). Si 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 de valeurs. Séparez-les 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 auquel les contrôles de santé sont effectués. Valeurs valides : 1 à 50. Unité : secondes. Valeur par défaut : 2. Unité : secondes.	2
HealthCheckTimeout	integer	Non	Le délai d'attente pour une réponse de contrôle de santé. Si un serveur back-end ne répond pas dans ce délai, le contrôle de santé échoue. Valeurs valides : 1 à 300. Unité : secondes. Valeur par défaut : 5. Unité : secondes.	5
HealthCheckPath	string	Non	L'URL utilisée pour les contrôles de santé. L'URL doit comporter de 1 à 80 caractères. Elle doit commencer par une barre oblique (/) et peut contenir des lettres, des chiffres et les caractères spéciaux suivants : `- / . % ? # & _;~!()[]@$^:',+`. Remarque* Ce paramètre prend effet uniquement lorsque le paramètre `HealthCheckProtocol` est défini sur HTTP ou HTTPS.	/test/index.html
HealthCheckMethod	string	Non	La méthode utilisée pour le contrôle de santé. Valeurs valides : HEAD (par défaut) : Pour les écouteurs HTTP et HTTPS, la méthode de contrôle de santé par défaut est HEAD. POST : Pour les écouteurs gRPC, la méthode de contrôle de santé par défaut est POST. 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é. 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 le contrôle de santé. Valeurs valides : HTTP (par défaut) : simule l'accès d'un navigateur en envoyant des requêtes HEAD ou GET pour vérifier si l'application serveur est saine. HTTPS : simule l'accès d'un navigateur en envoyant des requêtes HEAD ou GET pour vérifier si l'application serveur est saine. HTTPS fournit une transmission de données chiffrée et est plus sécurisé que HTTP. TCP : vérifie si le port du serveur est réactif en envoyant des paquets SYN. gRPC : vérifie si l'application serveur est saine en envoyant des requêtes POST ou GET.	HTTP
HealthCheckHttpVersion	string	Non	La version du protocole HTTP utilisée pour le contrôle de santé. 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.	HTTP 1.0
HealthyThreshold	integer	Non	Le nombre de contrôles de santé réussis consécutifs requis pour faire passer l'état de santé d'un serveur back-end de non sain à sain. Valeurs valides : 2 à 10. Valeur par défaut : 3.	4
UnhealthyThreshold	integer	Non	Le nombre de contrôles de santé échoués consécutifs requis pour faire passer l'état de santé d'un serveur back-end 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. Le système vérifie la requête pour détecter d'éventuels problèmes, notamment les paramètres obligatoires manquants, la syntaxe incorrecte de la requête et les limites de service. 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é. La ressource n'est pas créée. false (par défaut) : Envoie une requête normale. Si la requête est valide, un code d'état HTTP 2xx est renvoyé et le modèle de contrôle de santé est créé.	true
Tag	array<object>	Non	Les balises.
	object	Non	Les balises.
Key	string	Non	La clé de balise. La clé de balise peut comporter jusqu'à 128 caractères. Elle ne peut pas commencer par `aliyun` ou `acs:` et ne peut pas contenir `http://` ou `https://`.	env
Value	string	Non	La valeur de balise. La valeur de balise peut comporter jusqu'à 128 caractères. Elle ne peut pas commencer par `aliyun` ou `acs:` et ne peut pas contenir `http://` ou `https://`.	product
ResourceGroupId	string	Non	L'identifiant du groupe de ressources.	rg-atstuj3rtop****

Éléments de réponse

Élément	Type	Description	Exemple
	object	L'objet du modèle de contrôle de santé.
HealthCheckTemplateId	string	L'identifiant du modèle de contrôle de santé.	hct-pno8sisi******
RequestId	string	L'identifiant de la requête.	365F4154-92F6-4AE4-92F8-7FF34******

Exemples

JSON format

{
  "HealthCheckTemplateId": "hct-pno8sisi******",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34******"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	QuotaExceeded.HealthCheckTemplatesNum	The quota of %s is exceeded, usage %s/%s.	The quota of %s is exceeded. Usage: %s/%s.
403	Forbidden.HealthCheckTemplate	Authentication has failed for HealthCheckTemplate.

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

Notes de version

Consultez Notes de version pour la liste complète.