CreateInstantSiteMonitor - - Centre de documentation Alibaba Cloud

Crée une tâche de surveillance synthétique ponctuelle.

Description de l'opération

Seuls les comptes Alibaba Cloud ayant activé l'analyse et la surveillance du réseau peuvent créer des tâches de surveillance synthétique ponctuelles.

Cette rubrique fournit un exemple de création d'une tâche de surveillance synthétique ponctuelle. Le nom de la tâche est task1, l'adresse surveillée est http://www.aliyun.com, le type de tâche est HTTP et le nombre de points de détection est 1.

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

create

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Address	string	Oui	L'URL ou l'adresse IP de la tâche de surveillance synthétique.	http://www.aliyun.com
TaskType	string	Oui	Le type de la tâche de surveillance synthétique. Valeurs valides : HTTP, PING, TCP, UDP et DNS.	HTTP
TaskName	string	Oui	Le nom de la tâche de surveillance synthétique. Le nom doit comporter entre 4 et 100 caractères et peut contenir des lettres, des chiffres et des traits de soulignement (_).	task1
IspCities	string	Non	Les informations sur les points de détection. Si ce paramètre est laissé vide, le système sélectionne aléatoirement trois points de détection. La valeur est au format `JSONArray`. Exemple : [{"city":"546","isp":"465", "type":"IDC"},{"city":"572","isp":"465", "type":"LASTMILE"},{"city":"738","isp":"465"}], qui correspondent respectivement à Pékin, Hangzhou et Qingdao. Le champ type spécifie le type de point de détection. Lorsque AgentGroup est défini sur PC, les valeurs valides sont IDC et LASTMILE. IDC indique des points de détection déployés dans des centres de données. LASTMILE indique des points de détection déployés chez les utilisateurs finaux utilisant des réseaux fixes. Le champ type est facultatif et sa valeur par défaut est IDC. Lorsque AgentGroup est défini sur MOBILE, ce champ n'a pas besoin d'être spécifié. Pour plus d'informations sur la façon d'obtenir les informations sur les points de détection, consultez DescribeSiteMonitorISPCityList. Remarque Vous devez spécifier soit `IspCities`, soit `RandomIspCity`.	[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]
OptionsJson	string	Non	Les options étendues avancées pour le type de protocole de la tâche de surveillance synthétique. Différents types de protocoles correspondent à différentes options étendues.	{"time_out":5000}
RandomIspCity	integer	Non	Le nombre de points de détection. Remarque Vous devez spécifier soit `IspCities`, soit `RandomIspCity`.- Si vous définissez le paramètre `RandomIspCity`, le paramètre `IspCities` devient invalide.	1
AgentGroup	string	Non	Le type de points de détection. Valeurs valides : PC et MOBILE. PC indique des points de détection de réseau fixe. MOBILE indique des points de détection de réseau mobile. Valeur par défaut : PC. Valeurs valides : PC : Points de détection de réseau fixe. MOBILE : Points de détection de réseau mobile.	PC

Paramètres avancés pour TaskType

Les tableaux suivants décrivent comment configurer les paramètres avancés pour HTTP, PING, TCP, UDP et DNS dans TaskType.

HTTP

Paramètre	Type	Description
http_method	String	La méthode de requête HTTP. 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 ligne d'en-tête doit être conforme au format du protocole HTTP (paires clé-valeur séparées par un deux-points demi-chasse).
cookie	String	Le cookie, écrit au format de requête HTTP standard.
request_content	String	Le contenu de la requête. Deux formats sont pris en charge : JSON et form. S'il n'est pas fourni, la requête ne contient pas de corps.
response_content	String	Le contenu de réponse attendu. Lors de la détection, les 64 premiers octets renvoyés par le serveur HTTP sont vérifiés.
match_rule	String	0 : La détection réussit si la réponse ne contient pas response_content. 1 : La détection réussit si la réponse contient response_content.
username	String	Si un nom d'utilisateur est fourni, un en-tête BasicAuth est inclus dans la requête HTTP.
password	String	Le mot de passe pour l'authentification de la requête HTTP.
time_out	int	Le délai d'expiration. Unité : millisecondes. Valeur par défaut : 30000.
max_redirect	int	Le nombre maximal de redirections. La valeur par défaut est 5 pour les sondes ECS et 2 pour les points de détection des opérateurs. Définissez ce paramètre sur 0 pour désactiver les redirections. Valeurs valides : 0 à 50.

PING

Paramètre	Type	Description
failure_rate	int	Si le taux d'échec PING dépasse cette valeur, la détection échoue et renvoie 610 (PingAllFail) ou 615 (PingPartialFail). Valeur par défaut : 0.1.
ping_num	int	Le nombre de tentatives PING. Valeur par défaut : 20. Valeurs valides : 1 à 100.

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. Lorsque request_format est défini sur hex, la valeur de request_content est au format hexadécimal compact.
request_format	string	Lorsque request_format est défini sur d'autres valeurs, request_content est envoyé au serveur TCP ou UDP sous forme de chaîne de caractères brute.
response_content	string	Le contenu de la réponse. Si le contenu renvoyé par le serveur TCP ou UDP ne contient pas response_content, la détection échoue. Lorsque response_format est défini sur hex, la valeur de response_content est au format hexadécimal compact. Lorsque response_content est défini sur d'autres valeurs, response_content est une chaîne de caractères brute.

Paramètre	Type	Description
dns_server	string	L'adresse du serveur DNS, qui peut être un nom de domaine ou une adresse IP.
dns_type	string	Le type de requête DNS. Valeurs valides : A, NS, CNAME, MX, TXT et ANY.
expect_value	string	La liste des valeurs attendues séparées par des espaces.
match_rule	string	La relation entre la liste des valeurs attendues et la liste DNS. Si la relation spécifiée n'est pas respectée, la détection échoue. Chaîne vide ou IN_DNS : La liste des valeurs attendues est un sous-ensemble de la liste DNS. DNS_IN : La liste DNS est un sous-ensemble de la liste des valeurs attendues. EQUAL : La liste DNS est égale à la liste des valeurs attendues. ANY : La liste DNS et la liste des valeurs attendues ont une intersection non vide.

É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 renvoyé.	successful
RequestId	string	L'identifiant de la requête.	68192f5d-0d45-4b98-9724-892813f86c71
Success	string	Indique si l'opération a réussi. Valeurs valides : true : Succès. false : Échec.	true
CreateResultList	array<object>	La liste des résultats de la création de la tâche de surveillance synthétique ponctuelle.
	object	La liste des résultats de la création de la tâche de surveillance synthétique ponctuelle.
TaskId	string	L'identifiant de la tâche de surveillance synthétique.	2c8dbdf9-a3ab-46a1-85a4-f094965e****
TaskName	string	Le nom de la tâche de surveillance synthétique.	task1

Exemples

JSON format

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "68192f5d-0d45-4b98-9724-892813f86c71",
  "Success": "true",
  "CreateResultList": [
    {
      "TaskId": "2c8dbdf9-a3ab-46a1-85a4-f094965e****",
      "TaskName": "task1"
    }
  ]
}

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	OperatorCityInvalid	Operator City invalid
400	NameRepeat	Task name repeat
400	CreateAlarmError	Create alarm error
400	NameNotExists	Task name not exists
400	Illegal Task Name	The task name of the sitemonitor task is illegal.	Site monitoring task name is illegal.
401	AccessDeniedException	You donot have sufficient access to perform this action.
500	InternalError	%s
402	LimitExceeded	The quota for this customer had been reached.
403	%s	%s
403	Forbidden	%s
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.