CreateHostAvailability - - Centre de documentation Alibaba Cloud

Crée une tâche de surveillance de disponibilité.

Description de l'opération

Cette rubrique fournit un exemple de création d'une tâche de surveillance de disponibilité nommée task1 avec le type de détection défini sur HTTP dans le groupe d'applications 123456. Les notifications d'alerte sont envoyées par e-mail et par robot de discussion DingTalk.

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.

cms:CreateHostAvailability

create

*HostAvailability

acs:cms::{#accountId}:group/{#groupId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
GroupId	integer	Oui	L'identifiant du groupe d'applications.	123456
TaskName	string	Oui	Le nom de la tâche de surveillance de disponibilité. Le nom doit comporter entre 4 et 100 caractères et peut contenir des lettres, des chiffres, des traits de soulignement (_) et des caractères chinois.	task1
TaskScope	string	Non	La portée de détection de la tâche de surveillance de disponibilité. Valeurs valides : GROUP : utilise toutes les instances ECS du groupe d'applications actuel comme sondes de détection. GROUP_SPEC_INSTANCE : utilise les instances ECS spécifiées dans le groupe d'applications actuel comme sondes de détection. Si vous définissez ce paramètre sur GROUP_SPEC_INSTANCE, vous devez également définir InstanceList pour spécifier les instances ECS qui initient la détection.	GROUP
TaskType	string	Oui	Le type de détection de la tâche de surveillance de disponibilité. Valeurs valides : PING TELNET HTTP	HTTP
TaskOption.HttpURI	string	Non	L'URI pour la détection HTTP ou Telnet.	https://www.aliyun.com telnet://127.0.0.1:80
TaskOption.TelnetOrPingHost	string	Non	Le nom de domaine ou l'adresse à détecter. Remarque Si le type de détection est PING, définissez ce paramètre.	www.aliyun.com
TaskOption.HttpResponseCharset	string	Non	Le jeu de caractères de réponse pour la détection HTTP. Remarque Seul UTF-8 est pris en charge.	UTF-8
TaskOption.HttpPostContent	string	Non	Le contenu POST de la requête de détection HTTP.	params1=paramsValue1
TaskOption.HttpResponseMatchContent	string	Non	Le contenu à faire correspondre dans la réponse.	ok
TaskOption.HttpMethod	string	Non	La méthode pour le type de détection. Valeurs valides : GET POST HEAD Remarque Si le type de détection est HTTP, définissez ce paramètre.	GET
TaskOption.HttpNegative	boolean	Non	La règle d'alerte pour la correspondance du contenu de la réponse HTTP. Valeurs valides : true : une alerte est déclenchée si le contenu de la réponse HTTP contient le contenu de règle d'alerte spécifié. false : une alerte est déclenchée si le contenu de la réponse HTTP ne contient pas le contenu de règle d'alerte spécifié. Remarque Ce paramètre prend effet uniquement lorsque le type de détection est HTTP.	true
TaskOption.HttpHeader	string	Non	L'en-tête de la requête HTTP. Le format est Nom du paramètre:Valeur du paramètre. Séparez plusieurs paramètres par des sauts de ligne. Exemple : `params1:value1 params2:value2`	token:testTokenValue
TaskOption.Interval	integer	Non	La fréquence de détection. Unité : secondes. Valeurs valides : 15, 30, 60, 120, 300, 900, 1800 et 3600. Remarque Seul l'agent CloudMonitor version 3.5.1 ou ultérieure prend en charge ce paramètre.	60
AlertConfig.NotifyType	integer	Oui	Le type de notification d'alerte. Valeurs valides : 0 : e-mail + robot de discussion DingTalk.	0
AlertConfig.StartTime	integer	Non	L'heure de début à laquelle l'alerte prend effet. La valeur est un entier compris entre 0 et 23. Unité : heures. La valeur indique l'heure à laquelle la période effective commence. Le point de départ réel est 00:00:00 de l'heure spécifiée. Par exemple, une valeur de 0 indique que la période effective commence à 00:00:00. Le fuseau horaire est UTC+8. Remarque Si l'heure actuelle ne se situe pas dans la fenêtre de temps effective, les notifications d'alerte ne sont pas envoyées même si le seuil est dépassé.	0
AlertConfig.EndTime	integer	Non	L'heure de fin à laquelle l'alerte prend effet. La valeur est un entier compris entre 0 et 23. Unité : heures. La valeur indique l'heure à laquelle la période effective se termine. Le point de fin réel est 00:00:00 de l'heure spécifiée. Par exemple, une valeur de 22 indique que la période effective se termine à 22:00:00. Le fuseau horaire est UTC+8. Remarque Si l'heure actuelle ne se situe pas dans la fenêtre de temps effective, les notifications d'alerte ne sont pas envoyées même si le seuil est dépassé.	22
AlertConfig.SilenceTime	integer	Non	La période de mise en sourdine. Unité : secondes. Valeur par défaut : 86400 (1 jour).	86400
AlertConfig.WebHook	string	Non	L'adresse du webhook.	https://www.aliyun.com/webhook.json
AlertConfigEscalationList	array<object>	Oui	Aucun.
	object	Non	Aucun.
MetricName	string	Oui	La métrique de l'alerte. Valeurs valides de N : 1 à 21. Valeurs valides : HttpStatus : code d'état HTTP. HttpLatency : latence HTTP. TelnetStatus : code d'état Telnet. TelnetLatency : latence Telnet. PingLostRate : taux de perte de paquets Ping.	HttpStatus
Value	string	Non	Le seuil d'alerte. Valeurs valides de N : 1 à 21.	90
Times	integer	Non	Le nombre de tentatives d'alerte. Valeurs valides de N : 1 à 21.	3
Operator	string	Non	L'opérateur de comparaison pour la règle d'alerte. Valeurs valides de N : 1 à 21. Valeurs valides : Remarque Remarque = < <= =	>
Aggregate	string	Non	La méthode statistique pour l'alerte. Valeurs valides de N : 1 à 21. Les valeurs valides varient en fonction de la métrique : HttpStatus : Value. HttpLatency : Average. TelnetStatus : Value. TelnetLatency : Average. PingLostRate : Average. Remarque La méthode statistique pour les métriques de code d'état est la valeur d'origine (Value). La méthode statistique pour les métriques de latence ou de taux de perte de paquets est la valeur moyenne (Average).	Value
InstanceList	array	Non	La liste des instances ECS qui initient la détection. Valeurs valides de N : 1 à 21. Remarque Définissez ce paramètre lorsque TaskScope est défini sur GROUP_SPEC_INSTANCE.	i-absdfkwl321****
	string	Non	La liste des instances ECS qui initient la détection. Valeurs valides de N : 1 à 21. Remarque Définissez ce paramètre lorsque TaskScope est défini sur GROUP_SPEC_INSTANCE.	2
AlertConfigTargetList	array<object>	Non	Les cibles de déclenchement d'alerte.
	object	Non	Les cibles de déclenchement d'alerte.
Id	string	Non	L'identifiant de la cible de déclenchement d'alerte.	1
Arn	string	Non	L'ARN de la ressource. Format : acs:{AbbreviatedCloudServiceName}:{regionId}:{userId}:/{ResourceType}/{ResourceName}/message. Exemple : acs:mns:cn-hangzhou:120886317861**:/queues/test123/message. La liste suivante décrit les paramètres : {AbbreviatedCloudServiceName} : seul Simple Message Queue (anciennement MNS) est pris en charge. {userId} : l'identifiant du compte Alibaba Cloud. {regionId} : la région où réside la file d'attente ou la rubrique Simple Message Queue (anciennement MNS). {ResourceType} : le type de ressource qui accepte les alertes. Valeurs valides : queues : file d'attente. topics : rubrique. {ResourceName} : le nom de la ressource. Si le type de ressource est queues, le nom de la ressource est le nom de la file d'attente. Si le type de ressource est topics**, le nom de la ressource est le nom de la rubrique.	acs:mns:cn-hangzhou:120886317861****:/queues/test/message
Level	string	Non	Le niveau d'alerte. Valeurs valides : INFO : information. WARN : avertissement. CRITICAL : critique.	["INFO", "WARN", "CRITICAL"]
JsonParams	string	Non	Les paramètres au format JSON du rappel d'alerte.	{"customField1":"value1","customField2":"$.name"}

Pour plus d'informations sur les paramètres de requête courants, consultez Paramètres courants.

Éléments de réponse

Élément	Type	Description	Exemple
	object
Code	string	Le code d'état. Remarque Une valeur de 200 indique un succès.	200
Message	string	Le message d'erreur.	La ressource spécifiée est introuvable
RequestId	string	L'identifiant de la requête.	ACBDBB40-DFB6-4F4C-8957-51FFB233969C
TaskId	integer	L'identifiant de la tâche de surveillance de disponibilité.	12345
Success	boolean	Indique si l'opération a réussi. Valeurs valides : true : l'opération a réussi. false : l'opération a échoué.	true

Exemples

JSON format

{
  "Code": "200",
  "Message": "The specified resource is not found.",
  "RequestId": "ACBDBB40-DFB6-4F4C-8957-51FFB233969C",
  "TaskId": 12345,
  "Success": true
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	ParameterInvalid	Parameter invalid.	The parameter is invalid.
412	ResouceOverLimit	The task over limit
500	InternalError	The request processing has failed due to some unknown error.
403	AccessForbidden	User not authorized to operate on the specified resource.
404	ResourceNotFound	%s
409	ResourceConflict	Concurrent modification of resources.
409	ResourceExist	Resources already exist.

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

Notes de version

Consultez Notes de version pour la liste complète.