CreateSiteMonitor - - Centre de documentation Alibaba Cloud

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

Description de l'opération

Cette rubrique décrit comment créer une tâche de surveillance de site. L'exemple crée une tâche nommée HanZhou_ECS1 pour surveiller l'URL https://www.aliyun.com via HTTPS.

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

create

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Address	string	Oui	L'URL ou l'adresse IP à surveiller.	https://www.aliyun.com
TaskType	string	Oui	Le type de tâche de surveillance. Les protocoles valides incluent HTTP(S), PING, TCP, UDP, DNS, SMTP, POP3, FTP et WEBSOCKET.	HTTP
TaskName	string	Oui	Le nom de la tâche de surveillance. 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.	HanZhou_ECS1
Interval	string	Non	La fréquence de surveillance en minutes. Valeurs valides : 1, 5, 15, 30 et 60. Valeur par défaut : 1.	1
IspCities	string	Non	Les points de détection. Si vous ne spécifiez pas ce paramètre, le système sélectionne aléatoirement trois points de détection provenant de différents fournisseurs d'accès à Internet (FAI). La valeur doit être un tableau JSON. Exemple : `[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]`. Les valeurs correspondent à Pékin, Hangzhou et Qingdao. Pour plus d'informations, consultez DescribeSiteMonitorISPCityList.	[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]
OptionsJson	string	Non	Les options avancées pour le protocole spécifié. Les options disponibles varient en fonction du type de protocole.	{"time_out":5000}
AlertIds	string	Non	L'identifiant de la règle d'alerte. Pour plus d'informations, consultez DescribeMetricRuleList.	SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent
AgentGroup	string	Non	Le groupe de points de détection pour la tâche de sonde réseau. `PC` indique les points de détection sur des PC. `MOBILE` indique les points de détection sur des appareils mobiles. `FC` indique les points de détection dans un VPC. La valeur par défaut est `PC`.	PC
CustomSchedule	string	Non	Le planning de détection personnalisé. Spécifiez une période et les jours de la semaine pour la détection.	{"start_hour":0,"end_hour":24, "days":[0], "time_zone":"Local"}
VpcConfig	string	Non	Les informations réseau requises pour créer une tâche de sonde réseau dans un VPC. Il doit s'agir d'un objet JSON contenant les champs `vpcId`, `vswitchId`, `securityGroupId` et `region`.	{"vpcId": "vpc-xxxxxx", "vswitchId": "vsw-xxxxxx", "securityGroupId": "sg-xxxxxx", "region": "cn-beijing"}

Les tableaux suivants décrivent les paramètres avancés pour les types de tâches HTTP(S), PING, TCP, UDP, DNS, WEBSOCKET, SMTP, POP3 et FTP.

HTTP(S)

Paramètre	Type	Description
http_method	String	La méthode de requête HTTP ou HTTPS. Valeurs valides : GET, POST et HEAD. Valeur par défaut : GET.
header	String	L'en-tête HTTP personnalisé. Séparez plusieurs en-têtes par des sauts de ligne (\n). Chaque en-tête doit être au format `clé:valeur` et respecter le protocole HTTP.
cookie	String	Le cookie, formaté comme un cookie de requête HTTP standard.
request_content	String	Le contenu de la requête, au format JSON ou formulaire. Si vous ne spécifiez pas ce paramètre, le corps de la requête est vide.
response_content	String	Le contenu de réponse attendu. Le système vérifie les 64 premiers octets de la réponse du serveur.
match_rule	String	0 : la sonde réussit si la réponse ne contient pas la valeur response_content. 1 : la sonde réussit si la réponse contient la valeur response_content.
username	String	Le nom d'utilisateur pour l'authentification Basic. Si spécifié, un en-tête `BasicAuth` est inclus dans la requête HTTP.
password	String	Le mot de passe pour l'authentification Basic.
time_out	int	Le délai d'attente en millisecondes. Valeur par défaut : 5000.
max_redirect	int	Le nombre maximal de redirections. Valeur par défaut : 5 pour les points de détection ECS et 2 pour les points de détection d'opérateur. Définissez sur 0 pour désactiver les redirections. Valeurs valides : 0 à 50.

PING.

Paramètre	Type	Description
failure_rate	Text	Le seuil de taux d'échec. Si le taux d'échec du ping dépasse cette valeur, la sonde échoue et renvoie le code d'erreur 610 (PingAllFail) ou 615 (PingPartialFail). Valeur par défaut : 0.1.
ping_num	int	Le nombre de paquets ping à envoyer. Valeur par défaut : 10. Valeurs valides : 1 à 100.

DNS.

Paramètre	Type	Description
dns_server	string	L'adresse du serveur DNS. Il peut s'agir d'un nom de domaine ou d'une adresse IP.
dns_type	string	Le type de requête DNS. Valeurs valides : A, NS, CNAME, MX, TXT, ANY et AAAA.
expect_value	string	Une liste de valeurs attendues séparées par des espaces.
match_rule	string	La règle de correspondance entre les valeurs attendues et les résultats de la requête DNS. La sonde échoue si cette règle n'est pas respectée. `IN_DNS `ou chaîne vide : les valeurs attendues doivent être un sous-ensemble des résultats DNS.<br>\`DNS_IN `: les résultats DNS doivent être un sous-ensemble des valeurs attendues.<br>\`EQUAL `: les résultats DNS doivent être identiques aux valeurs attendues.<br>\`ANY` : les résultats DNS et les valeurs attendues doivent avoir au moins une valeur en commun.

FTP.

Paramètre	Type	Description
port	int	Le port du serveur FTP. Valeur par défaut : 21 pour FTP et 990 pour FTPS.
username	string	Le nom d'utilisateur pour la connexion FTP. S'il n'est pas spécifié, une connexion anonyme est utilisée.
password	string	Le mot de passe pour la connexion FTP.

POP3 ou SMTP.

Paramètre	Type	Description
port	int	Le port du serveur. Valeur par défaut : 110 pour POP3, 995 pour POP3S et 25 pour SMTP.
username	string	Le nom d'utilisateur pour la connexion POP3 ou SMTP. Le nom d'utilisateur et le mot de passe sont tous deux requis.
password	string	Le mot de passe pour la connexion POP3 ou SMTP. Le nom d'utilisateur et le mot de passe sont tous deux requis.

TCP ou UDP.

Paramètre	Type	Description
port	int	Le port du serveur TCP ou UDP.
request_content	string	Le contenu de la requête. Si `request_format` est `hex`, cette valeur doit être au format hexadécimal compact.
request_format	string	Le format du contenu de la requête. S'il ne s'agit pas de `hex`, le `request_content` est envoyé sous forme de chaîne classique.
response_content	string	Le contenu de réponse attendu. La sonde échoue si la réponse du serveur ne contient pas cette valeur. Si `request_format` est `hex`, cette valeur doit être au format hexadécimal compact. Sinon, elle est traitée comme une chaîne classique.

WEBSOCKET.

Paramètre	Type	Description
request_content	string	Le contenu du message à envoyer.
empty_message	boolean	Indique si un message vide ou l'absence de message du serveur est considéré comme un succès.

Éléments de réponse

Élément	Type	Description	Exemple
	object	N/A.
Code	string	Le code d'état de l'opération. Remarque Une valeur de `200` indique un succès.	200
Message	string	Le message renvoyé pour la requête.	Successful
RequestId	string	L'identifiant de la requête.	68192f5d-0d45-4b98-9724-892813f86c71
Success	string	Indique si la requête a réussi. Valeurs valides : true : la requête a réussi. false : la requête a échoué.	true
Data	object	Les résultats de la tâche de surveillance.
AttachAlertResult	object
Contact	array<object>	The results of associating the alert rules.
	object	The result for a single alert rule association.
Code	string	The status code for the association operation. Remarque A value of `200` indicates success.	200
Message	string	The message returned for the association operation.	successful
RequestId	string	The request ID for the association operation.	5dd33455-4f65-4b0c-9200-33d66f3f340b
Success	string	Indicates whether the alert rule was successfully associated. Valid values: true: The association was successful. false: The association failed.	true
RuleId	string	The ID of the alert rule.	SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent
CreateResultList	object
CreateResultList	array<object>	Une liste de résultats pour chaque tâche créée. Ceci n'est renvoyé que si la création de la tâche réussit.
	object	Le résultat pour une seule tâche créée. Ceci n'est renvoyé que si la création de la tâche réussit.
TaskId	string	The ID of the created monitoring task.	2c8dbdf9-a3ab-46a1-85a4-f094965e****
TaskName	string	The name of the created monitoring task.	HanZhou_ECS1

Exemples

JSON format

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

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidQueryParameter	%s
400	IllegalAddress	Illegal HTTP address
400	OperationError	Operation failed
400	TaskNotExists	Task does not exist
400	OperatorInvalid	Operator invalid
400	NameRepeat	Task name repeat
400	CreateAlarmError	Create alarm error
400	NameNotExists	Task name not exists
400	OperatorCityInvalid	Invalid Isp.	Invalid Isp
401	AccessDeniedException	You donot have sufficient access to perform this action.
500	InternalError	The request processing has failed due to some unknown error.
402	LimitExceeded	The quota for this customer had been reached.
403	Forbidden	%s
403	RestrictedUser	The user's operation is restricted, please register NAAM product code
503	%s	%s
406	ExceedingQuota	Exceeding quota limits.	The number of tasks exceeds the limit
409	%s	%s

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

Notes de version

Consultez Notes de version pour la liste complète.