Tous les produits
Search
Centre de documentation

:CreateHostAvailability

Dernière mise à jour :Aug 08, 2026

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

Cette rubrique explique comment créer la tâche de surveillance de la disponibilité task1 dans le groupe d'applications 123456. Le paramètre TaskType de la tâche est défini sur HTTP. Une fois la tâche lancée, le système envoie des alertes à l'adresse e-mail et au robot DingTalk spécifiés.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Parameter Type Required Example Description
Action String Yes CreateHostAvailability

Opération à exécuter. Définissez la valeur sur CreateHostAvailability.

GroupId Long Yes 123456

ID du groupe d'applications.

TaskName String Yes task1

Nom de la tâche de surveillance de la disponibilité. La longueur doit être comprise entre 4 et 100 caractères et peut contenir des lettres, des chiffres et des traits de soulignement (_).

TaskScope String No GROUP

Plage d'instances surveillées par la tâche de surveillance de la disponibilité. Valeurs valides :

  • GROUP : toutes les instances ECS du groupe d'applications sont surveillées.
  • GROUP_SPEC_INSTANCE : les instances ECS spécifiées dans le groupe d'applications sont surveillées. Le paramètre TaskScope doit être utilisé conjointement avec le paramètre InstanceList.N. Le paramètre InstanceList.N spécifie les instances ECS à surveiller.
TaskType String Yes HTTP

Type de surveillance de la tâche de surveillance de la disponibilité. Valeurs valides :

  • PING
  • TELNET
  • HTTP
TaskOption.HttpURI String No https://www.aliyun.com

URI que vous souhaitez surveiller. Si le paramètre TaskType est défini sur HTTP, ce paramètre est obligatoire.

TaskOption.TelnetOrPingHost String No www.aliyun.com

Nom de domaine ou adresse IP que vous souhaitez surveiller.

Remarque Si le paramètre TaskType est défini sur PING ou TELNET, ce paramètre est obligatoire.
TaskOption.HttpResponseCharset String No UTF-8

Jeu de caractères utilisé dans la réponse HTTP.

Remarque Valeur valide : UTF-8.
TaskOption.HttpPostContent String No params1=paramsValue1

Contenu de la requête HTTP POST.

TaskOption.HttpResponseMatchContent String No ok

Réponse à la requête HTTP.

TaskOption.HttpMethod String No GET

Méthode de requête HTTP. Valeurs valides :

  • GET
  • POST
  • HEAD
Remarque Si le paramètre TaskType est défini sur HTTP, ce paramètre est obligatoire.
TaskOption.HttpNegative Boolean No true

Méthode de déclenchement d'une alerte. L'alerte se déclenche selon que la règle d'alerte spécifiée est incluse ou non dans le corps de la réponse. Valeurs valides :

  • true : si le corps de la réponse HTTP inclut la règle d'alerte, une alerte est déclenchée.
  • false : si la réponse HTTP n'inclut pas la règle d'alerte, une alerte est déclenchée.
Remarque Si le paramètre TaskType est défini sur HTTP, ce paramètre prend effet.
TaskOption.HttpHeader String No token:testTokenValue

En-tête de la requête HTTP. Format : nom_du_paramètre:valeur_du_paramètre. Séparez plusieurs paramètres par des caractères de retour chariot. Exemple :


params1:value1
params2:value2
TaskOption.Interval Integer No 60

Intervalle d'envoi des requêtes de détection. Unité : secondes. Valeurs valides : 15, 30, 60, 120, 300, 900, 1800 et 3600.

Remarque Ce paramètre est disponible uniquement pour l'agent CloudMonitor version 3.5.1 ou ultérieure.
AlertConfig.NotifyType Integer Yes 0

Méthodes de notification d'alerte. Valeurs valides :

0 : les notifications d'alerte sont envoyées par e-mail et via des robots DingTalk.

AlertConfig.StartTime Integer No 0

Début de la période pendant laquelle la règle d'alerte est effective. Valeurs valides : 0 à 23.

Par exemple, si le paramètre AlertConfig.StartTime est défini sur 0 et le paramètre AlertConfig.EndTime sur 22, la règle d'alerte est effective de 00:00:00 à 22:00:00.

Remarque Les notifications d'alerte sont envoyées en fonction du seuil spécifié uniquement si la règle d'alerte est effective.
AlertConfig.EndTime Integer No 22

Fin de la période pendant laquelle la règle d'alerte est effective. Valeurs valides : 0 à 23.

Par exemple, si le paramètre AlertConfig.StartTime est défini sur 0 et le paramètre AlertConfig.EndTime sur 22, la règle d'alerte est effective de 00:00:00 à 22:00:00.

Remarque Les notifications d'alerte sont envoyées en fonction du seuil spécifié uniquement si la règle d'alerte est effective.
AlertConfig.SilenceTime Integer No 86400

Période de silence durant laquelle aucune nouvelle alerte n'est envoyée, même si les conditions de déclenchement sont remplies. Unité : secondes. Valeur par défaut : 86400 (un jour).

AlertConfig.WebHook String No https://www.aliyun.com/webhook.json

URL de rappel.

AlertConfigEscalationList.N.MetricName String Yes HttpStatus

Métrique pour laquelle la fonction d'alerte est activée. Valeurs valides de N : 1 à 21. Valeurs valides :

  • HttpStatus : code d'état HTTP
  • HttpLatency : temps de réponse HTTP
  • TelnetStatus : code d'état Telnet
  • TelnetLatency : temps de réponse Telnet
  • PingLostRate : taux de perte de paquets Ping
AlertConfigEscalationList.N.Value String No 90

Seuil d'alerte. Valeurs valides de N : 1 à 21.

AlertConfigEscalationList.N.Times Integer No 3

Nombre consécutif de fois où la valeur de la métrique satisfait à la condition d'alerte avant qu'une alerte ne soit déclenchée. Valeurs valides de N : 1 à 21.

AlertConfigEscalationList.N.Operator String No >

Opérateur de comparaison utilisé dans la règle d'alerte. Valeurs valides de N : 1 à 21. Valeurs valides :

  • >
  • >=
  • <
  • <=
  • =
AlertConfigEscalationList.N.Aggregate String No Value

Méthode utilisée pour calculer les valeurs de métriques qui déclenchent des alertes. Valeurs valides de N : 1 à 21. Valeurs valides :

  • HttpStatus : Value
  • HttpLatency : Average
  • TelnetStatus : Value
  • TelnetLatency : Average
  • PingLostRate : Average
Remarque La valeur Value indique la valeur d'origine et est utilisée pour les métriques telles que les codes d'état. La valeur Average indique la valeur moyenne et est utilisée pour les métriques telles que la latence et le taux de perte de paquets.
InstanceList.N String No 2

Instances ECS surveillées. Valeurs valides de N : 1 à 21.

Remarque Si le paramètre TaskScope est défini sur GROUP_SPEC_INSTANCE, ce paramètre est obligatoire.
AlertConfigTargetList.N.Id String No 1

ID de la ressource pour laquelle les alertes sont déclenchées.

AlertConfigTargetList.N.Arn String No acs:mns:cn-hangzhou:120886317861****:/queues/test/message

Nom de ressource Alibaba Cloud (ARN) de la ressource. Format : acs:{abbr_nom_service}:{regionId}:{userId}:/{type_ressource}/{nom_ressource}/message. Exemple : acs:mns:cn-hangzhou:120886317861****:/queues/test123/message. Champs :

  • {abbr_nom_service} : abréviation du nom du service. Valeur valide : mns.
  • {userId} : ID du compte Alibaba Cloud.
  • {regionId} : ID de région de la file d'attente de messages ou du topic.
  • {type_ressource}: type de ressource pour laquelle les alertes sont déclenchées. Valeurs valides : - **queues** - **topics** {nom_ressource} : nom de la ressource. - Si le type de ressource est défini sur **queues**, le nom de la ressource correspond au nom de la file d'attente de messages. - Si le type de ressource est défini sur **topics**, le nom de la ressource correspond au nom du topic.
AlertConfigTargetList.N.Level String No ["INFO", "WARN", "CRITICAL"]

Niveau de l'alerte. Valeurs valides :

  • INFO : information
  • WARN : avertissement
  • CRITICAL : critique
AlertConfigTargetList.N.JsonParams String No {"customField1":"value1","customField2":"$.name"}

Paramètres du rappel d'alerte. Les paramètres sont au format JSON.

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

Paramètres de réponse

Parameter Type Example Description
Code String 200

Code d'état HTTP.

Remarque Le code d'état 200 indique que l'appel a réussi.
Message String The specified resource is not found.

Message d'erreur.

RequestId String ACBDBB40-DFB6-4F4C-8957-51FFB233969C

ID de la requête.

TaskId Long 12345

ID de la tâche de surveillance de la disponibilité.

Success Boolean true

Indique si l'appel a réussi. Valeurs valides :

  • true : l'appel a réussi.
  • false : l'appel a échoué.

Exemples

Exemple de requête

http(s)://[Endpoint]/?Action=CreateHostAvailability
&AlertConfig.NotifyType=0
&AlertConfigEscalationList.1.MetricName=HttpStatus
&GroupId=123456
&TaskName=task1
&TaskType=HTTP
&<Common request parameters>

Exemple de réponse réussie

Format XML

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

<CreateHostAvailabilityResponse>
	<TaskId>12345</TaskId>
	<RequestId>CDA78493-F10F-485F-98AD-B4C0B40AB225</RequestId>
	<Code>200</Code>
	<Success>true</Success>
</CreateHostAvailabilityResponse>

Format JSON

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

{
  "TaskId" : "12345",
  "RequestId" : "CDA78493-F10F-485F-98AD-B4C0B40AB225",
  "Code" : 200,
  "Success" : true
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez le Centre d'erreurs API.