CreateSiteMonitor - - Centre de documentation Alibaba Cloud

Cette rubrique explique comment créer une tâche de surveillance de site nommée HanZhou_ECS1. L'URL surveillée par la tâche est https://www.aliyun.com et le type de tâche est HTTPS.

Débogage

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

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	CreateSiteMonitor	Opération à effectuer. Définissez la valeur sur CreateSiteMonitor.
Address	String	Oui	https://www.aliyun.com	URL ou adresse IP surveillée par la tâche.
TaskType	String	Oui	HTTPS	Type de la tâche de surveillance de site. Valeurs valides : HTTP, HTTPS, PING, TCP, UDP, DNS, SMTP, POP3 et FTP.
TaskName	String	Oui	HanZhou_ECS1	Nom de la tâche de surveillance de site. Le nom doit comporter entre 4 et 100 caractères et peut contenir des lettres, des chiffres et des traits de soulignement (_).
Interval	String	Non	1	Intervalle d'envoi des requêtes de détection. Valeurs valides : 1, 5, 15, 30 et 60. Unité : minutes. Valeur par défaut : 1.
IspCities	String	Non	[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]	Informations relatives aux points de détection. Si ce paramètre est vide, le système sélectionne aléatoirement trois points de détection. La valeur est un tableau JSON. Exemple : `[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]`. Les valeurs du champ city indiquent Pékin, Hangzhou et Qingdao. Pour obtenir les points de détection, consultez DescribeSiteMonitorISPCityList.
OptionsJson	String	Non	{"time_out":5000}	Options étendues du protocole utilisé par la tâche de surveillance de site. Les options varient selon le protocole.
AlertIds	String	Non	SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent	ID de la règle d'alerte. Pour obtenir l'ID d'une règle d'alerte, consultez DescribeMetricRuleList.

Les tableaux suivants décrivent les options étendues des protocoles HTTP, HTTPS, PING, TCP, UDP, DNS, SMTP, POP3 et FTP spécifiés par le paramètre TaskType.

HTTP ou HTTPS

Paramètre	Type	Description
http_method	String	Méthode de requête HTTP ou HTTPS. Valeurs valides : GET, POST et HEAD. Valeur par défaut : GET.
header	String	En-têtes HTTP personnalisés séparés par des sauts de ligne (\n). Chaque en-tête doit être conforme au protocole HTTP. Chaque en-tête doit être une paire clé-valeur où la clé et la valeur sont séparées par deux-points (:).
cookie	String	Cookie HTTP spécifié conformément à la norme de requête HTTP.
request_content	String	Contenu de la requête. Le contenu peut être au format JSON ou formulaire. Si ce paramètre n'est pas spécifié, le corps de la requête est vide.
response_content	String	Contenu attendu de la réponse. Lors de la surveillance du site, les 64 premiers octets du contenu renvoyé par le serveur HTTP sont vérifiés.
match_rule	String	0 : si la réponse ne contient pas le contenu spécifié par le paramètre response_content, la détection réussit. 1 : si la réponse contient le contenu spécifié par le paramètre response_content, la détection réussit.
username	String	Si le paramètre username est spécifié, la requête HTTP contient l'en-tête d'authentification de base.
password	String	Mot de passe utilisé pour authentifier la requête HTTP ou HTTPS.
time_out	int	Délai d'expiration. Unité : millisecondes. Valeur par défaut : 5.
max_redirect	int	Nombre maximal de redirections. La valeur par défaut est 5 pour un point de détection exécuté sur une instance Elastic Compute Service (ECS) et 2 pour un point de détection fourni par un opérateur. Pour désactiver les redirections, définissez la valeur sur 0. Valeurs valides : 0 à 50.

PING

Paramètre

Type

Description

failure_rate

Text

Si le taux d'échec des pings dépasse la valeur de ce paramètre, la détection échoue et le code d'état 610 ou 615 est renvoyé. Le message d'erreur du code d'état 610 est PingAllFail et celui du code d'état 615 est PingPartialFail.

Valeur par défaut : 0,1.

ping_num

int

Nombre de pings envoyés à l'adresse surveillée. Valeur par défaut : 10.

Valeurs valides : 1 à 100.

DNS

Paramètre	Type	Description
dns_server	string	Nom de domaine ou adresse IP du serveur Domain Name System (DNS).
dns_type	string	Type des enregistrements DNS à interroger. Valeurs valides : A, NS, CNAME, MX, TXT, ANY et AAAA.
expect_value	string	Liste des valeurs attendues. Séparez les valeurs attendues par des espaces.
match_rule	string	Relation entre la liste des valeurs attendues et la liste des résultats DNS. Si les deux listes ne satisfont pas la relation spécifiée, la détection échoue. Valeurs valides : Chaîne vide ou IN_DNS : la liste des valeurs attendues est un sous-ensemble de la liste des résultats DNS. DNS_IN : la liste des résultats DNS est un sous-ensemble de la liste des valeurs attendues. EQUAL : la liste des résultats DNS est identique à la liste des valeurs attendues. ANY : la liste des résultats DNS intersecte avec la liste des valeurs attendues.

FTP

Paramètre	Type	Description
port	int	Numéro de port du serveur FTP. Si ce paramètre n'est pas spécifié, la valeur par défaut est utilisée. Le numéro de port par défaut est 21 pour FTP et 990 pour FTPS.
username	string	Nom d'utilisateur utilisé pour se connecter au serveur FTP. Si ce paramètre n'est pas spécifié, la connexion anonyme est utilisée.
password	string	Mot de passe utilisé pour se connecter au serveur FTP.

POP3 ou SMTP

Paramètre	Type	Description
port	int	Numéro de port du serveur POP3 ou SMTP. Le numéro de port par défaut est 110 pour POP3, 995 pour POP3S et 25 pour SMTP.
username	string	Nom d'utilisateur utilisé pour se connecter au serveur POP3 ou SMTP. Le nom d'utilisateur et le mot de passe sont obligatoires.
password	string	Mot de passe utilisé pour se connecter au serveur POP3 ou SMTP. Le nom d'utilisateur et le mot de passe sont obligatoires.

TCP ou UDP

Paramètre	Type	Description
port	int	Numéro de port du serveur TCP ou UDP.
request_content	string	Contenu de la requête. Si le paramètre request_format est défini sur hex, la valeur du paramètre request_content est analysée au format hexadécimal.
request_format	string	Si le paramètre request_format est défini sur une autre valeur, la valeur du paramètre request_content est envoyée au serveur TCP ou UDP sous forme de chaîne standard.
response_content	string	Contenu de la réponse. Si la réponse du serveur TCP ou UDP ne contient pas le contenu spécifié par le paramètre response_content, la détection échoue. Si le paramètre response_format est défini sur hex, la valeur du paramètre response_content est analysée au format hexadécimal. Si le paramètre response_format est défini sur une autre valeur, la valeur du paramètre response_content est analysée comme une chaîne standard.

Paramètres de réponse

Paramètre	Type	Exemple	Description
Code	String	200	Code d'état HTTP. Remarque Le code d'état 200 indique que l'appel a réussi.
Message	String	Successful	Message renvoyé.
RequestId	String	68192f5d-0d45-4b98-9724-892813f86c71	ID de la requête.
Success	String	true	Indique si l'appel a réussi. Valeurs valides : true : l'appel a réussi. false : l'appel a échoué.
Data	Object		Résultat de la tâche de surveillance de site.
AttachAlertResult	Array of Contact		Résultat renvoyé après l'association de la règle d'alerte existante à la tâche de surveillance de site.
Contact
Code	String	200	Code d'état renvoyé après l'association de la règle d'alerte existante à la tâche de surveillance de site. Remarque Le code d'état 200 indique que l'appel a réussi.
Message	String	successful	Message renvoyé après l'association de la règle d'alerte existante à la tâche de surveillance de site.
RequestId	String	5dd33455-4f65-4b0c-9200-33d66f3f340b	ID de la requête envoyée pour associer la règle d'alerte existante à la tâche de surveillance de site.
Success	String	true	Indique si la règle d'alerte existante a été associée à la tâche de surveillance de site. Valeurs valides : true false
RuleId	String	SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent	ID de la règle d'alerte.
CreateResultList	Array of CreateResultList		Résultat de la requête. Si une tâche de surveillance de site est créée, le résultat est renvoyé. Si la création d'une tâche de surveillance de site échoue, aucun résultat n'est renvoyé.
CreateResultList
TaskId	String	2c8dbdf9-a3ab-46a1-85a4-f094965e****	ID de la tâche de surveillance de site.
TaskName	String	HanZhou_ECS1	Nom de la tâche de surveillance de site.

Exemples

Exemples de requêtes

http(s)://[Endpoint]/?Action=CreateSiteMonitor
&Address=https://www.aliyun.com
&TaskName=HanZhou_ECS1
&TaskType=HTTPS
&<Common request parameters>

Exemples de réponses réussies

Format XML

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

<CreateSiteMonitorResponse>
	<Message>successful</Message>
	<RequestId>68192f5d-0d45-4b98-9724-892813f86c71</RequestId>
	<Data>
		<AttachAlertResult>
			<Contact>
				<Message>successful</Message>
				<RequestId>5dd33455-4f65-4b0c-9200-33d66f3f340b</RequestId>
				<RuleId>SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent</RuleId>
				<Code>200</Code>
				<Success>true</Success>
			</Contact>
		</AttachAlertResult>
	</Data>
	<Code>200</Code>
	<CreateResultList>
		<CreateResultList>
			<TaskId>2c8dbdf9-a3ab-46a1-85a4-f094965e****</TaskId>
			<TaskName>HanZhou_ECS1</TaskName>
		</CreateResultList>
	</CreateResultList>
	<Success>true</Success>
</CreateSiteMonitorResponse>

Format JSON

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

{
  "Message" : "successful",
  "RequestId" : "68192f5d-0d45-4b98-9724-892813f86c71",
  "Data" : {
    "AttachAlertResult" : {
      "Contact" : [ {
        "Message" : "successful",
        "RequestId" : "5dd33455-4f65-4b0c-9200-33d66f3f340b",
        "RuleId" : "SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent",
        "Code" : "200",
        "Success" : true
      } ]
    }
  },
  "Code" : "200",
  "CreateResultList" : {
    "CreateResultList" : [ {
      "TaskId" : "2c8dbdf9-a3ab-46a1-85a4-f094965e****",
      "TaskName" : "HanZhou_ECS1"
    } ]
  },
  "Success" : true
}

Codes d'erreur

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