DescribeSiteMonitorList - - Centre de documentation Alibaba Cloud

Consulte la liste des tâches de surveillance de site en appelant l'opération DescribeSiteMonitorList.

Description de l'opération

Cette rubrique fournit un exemple de requête pour obtenir la liste des tâches de surveillance de site pour le compte actuel. La réponse indique que le compte actuel possède un enregistrement de surveillance de site nommé HanZhou_ECS2.

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

get

*Toutes les ressources.

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
TaskId	string	Non	L'identifiant de la tâche de surveillance de site.	a1ecd34a-8157-44d9-b060-14950837****
TaskType	string	Non	Le type de la tâche de surveillance de site. CloudMonitor prend en charge les types suivants : HTTP, PING, TCP, UDP, DNS, SMTP, POP3 et FTP.	HTTP
Keyword	string	Non	Le mot-clé utilisé pour rechercher des tâches de surveillance de site. Remarque La correspondance approximative est prise en charge en fonction du nom de la tâche ou de l'adresse de la tâche.	site
Page	integer	Non	Le numéro de page. Valeur par défaut : 1.	1
PageSize	integer	Non	Le nombre d'entrées par page. Valeur par défaut : 10.	10
TaskState	string	Non	L'état de la tâche. Valeurs valides : 1 : Normal. 2 : Désactivé.	1
AgentGroup	string	Non	Le type de nœuds de surveillance utilisés par la tâche. Valeurs valides : PC : Points de détection basés sur PC. MOBILE : Points de détection basés sur mobile. FC : Points de détection internes. Valeurs valides : PC : Points de détection basés sur PC. FC : Points de détection internes. MOBILE : Points de détection basés sur mobile.	PC

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	Aucune.
RequestId	string	L'identifiant de la requête.	A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B
Success	string	Indique si l'opération a réussi. Valeurs valides : true : Réussite. false : Échec.	true
Code	string	Le code d'état. Remarque 200 indique un succès.	200
Message	string	Le message renvoyé.	successful
PageNumber	integer	Le numéro de page.	1
PageSize	integer	Le nombre d'entrées par page.	10
TotalCount	integer	Le nombre total d'entrées.	1
SiteMonitors	object
SiteMonitor	array<object>	La liste des tâches de surveillance de site.
	array<object>	Aucune.
TaskType	string	Le type de la tâche de surveillance de site. CloudMonitor prend en charge les types suivants : HTTP, PING, TCP, UDP, DNS, SMTP, POP3 et FTP.	TCP
UpdateTime	string	L'heure de la dernière mise à jour de la tâche de surveillance de site, au format AAAA-MM-JJ HH:mm:ss.	2022-03-08 17:14:31
Interval	string	L'intervalle de surveillance. Unité : minutes.	1
TaskState	string	L'état de la tâche. Valeurs valides : 1 : Normal. 2 : Désactivé.	1
CreateTime	string	L'heure de création de la tâche, au format AAAA-MM-JJ HH:mm:ss.	2021-11-01 11:05:18
TaskName	string	Le nom de la tâche de surveillance de site.	Nouvelle tâche de surveillance
Address	string	L'URL ou l'adresse IP surveillée par la tâche.	https://aliyun.com
TaskId	string	L'identifiant de la tâche de surveillance de site.	f5783760-1b39-4b6b-80e8-453d962a****
OptionsJson	object	Les options étendues. Chaque type de surveillance possède des options étendues différentes. Pour plus d'informations, consultez CreateSiteMonitor.
password	string	Le mot de passe pour le type de surveillance SMTP, POP3 ou FTP.	123****
request_format	string	Le format du contenu de la requête HTTP. Valeurs valides : hex : format hexadécimal. txt : format texte.	hex
response_content	string	Le contenu de réponse correspondant. Format hexadécimal : lorsque le contenu de la requête est une chaîne d'octets qui ne peut pas être représentée par des caractères visibles, vous pouvez convertir la chaîne d'octets en chaîne hexadécimale. La règle de conversion est la suivante : un octet est converti en une chaîne hexadécimale de deux caractères. Par exemple, 1 octet (1B) est converti en `01` en hexadécimal, et 27 octets (27B) sont convertis en `1B` en hexadécimal. Le tableau binaire (au format Java) `{(byte)1, (byte)27}` est converti en `011b` ou `011B` en hexadécimal. La surveillance de site ne fait pas la distinction entre les majuscules et les minuscules pour les valeurs hexadécimales. Saisissez la chaîne `011B` dans le contenu de la requête et sélectionnez le format hexadécimal pour le format du contenu de la requête. Format texte : le texte brut fait référence à une chaîne composée de caractères visibles.	cf0f85
failure_rate	number	Le taux de perte de paquets. Remarque Ce paramètre s'applique uniquement au type de surveillance PING.	0.5
time_out	integer	Le délai d'expiration. Unité : millisecondes.	3000
header	string	L'en-tête de requête HTTP. Le format est `key1:value1`, les entrées étant séparées par des sauts de ligne.	testKey:testValue
cookie	string	Le texte du cookie pour la requête HTTP.	lang=en
port	integer	Le port pour le type de surveillance TCP, UDP, SMTP ou POP3.	80
ping_num	integer	Le nombre de tentatives PING.	20
authentication	integer	Indique si l'authentification de sécurité doit être activée. Valeurs valides : 0 : Activée. 1 : Désactivée.	1
http_method	string	La méthode de requête HTTP. Valeurs valides : get post head	get
match_rule	integer	Indique si des règles d'alerte sont incluses. Valeurs valides : 0 : Incluses. 1 : Non incluses.	0
dns_match_rule	string	La règle de correspondance DNS. Valeurs valides : IN_DNS : Les alias ou adresses IP attendus sont tous inclus dans la réponse DNS. DNS_IN : Toutes les réponses DNS sont incluses dans les alias ou adresses IP attendus. EQUAL : La réponse DNS correspond exactement aux alias ou adresses IP attendus. ANY : La réponse DNS et les alias ou adresses IP attendus ont une intersection.	IN_DNS
request_content	string	Le contenu de la requête HTTP.	cf0f85
username	string	Le nom d'utilisateur pour FTP, SMTP ou POP3.	testUser
response_format	string	Le format du contenu de la réponse HTTP. Valeurs valides : hex : format hexadécimal. txt : format texte.	hex
dns_type	string	Le type de résolution DNS. Ce paramètre s'applique uniquement au type de surveillance DNS. Valeurs valides : A (par défaut) : Spécifie l'adresse IP correspondant au nom d'hôte ou au nom de domaine. CNAME : Mappe plusieurs noms de domaine vers un autre nom de domaine. NS : Spécifie le serveur DNS qui résout le nom de domaine. MX : Pointe le nom de domaine vers l'adresse d'un serveur de messagerie. TXT : La description du nom d'hôte ou du nom de domaine. La longueur du texte est limitée à 512 octets et est généralement utilisée pour les enregistrements SPF (Sender Policy Framework) à des fins anti-spam. AAAA : L'enregistrement DNS qui résout un nom de domaine en une adresse IPv6.	A
dns_server	string	Le nom de domaine ou l'adresse IP du serveur DNS spécifié.	192.168.XX.XX
enable_operator_dns	boolean	Indique si le DNS de l'opérateur doit être utilisé. Valeurs valides : true (par défaut) : Utilise le DNS de l'opérateur. false : N'utilise pas le DNS de l'opérateur. Utilise le DNS par défaut ou le DNS du serveur spécifié.	true
attempts	integer	Le nombre de tentatives après un échec DNS.	3
protocol	string	Le type de protocole DNS. Valeurs valides : udp (par défaut) tcp tcp-tls	udp
proxy_protocol	boolean	Indique si ProxyProtocol doit être activé. Valeurs valides : false (par défaut) : Désactive ProxyProtocol. true : Active ProxyProtocol.	false
acceptable_response_code	string	Les codes d'état acceptables. Remarque Utilisez plutôt les configurations d'assertion.	400
isBase64Encode	string	Indique si le mot de passe doit être décodé et stocké à l'aide de Base64. Valeurs valides : true : Décode et stocke le mot de passe à l'aide de Base64. false (par défaut) : Ne décode pas et ne stocke pas le mot de passe à l'aide de Base64.	false
cert_verify	boolean	Indique si le certificat doit être vérifié. Valeurs valides : false (par défaut) : Ignore la vérification du certificat. true : Vérifie le certificat.	false
unfollow_redirect	boolean	Indique s'il faut suivre les redirections lorsqu'un code d'état 301 ou 302 est renvoyé. Valeurs valides : true : Ne suit pas les redirections. false (par défaut) : Suit les redirections.	false
diagnosis_mtr	boolean	Indique si les diagnostics réseau MTR automatiques doivent être activés après l'échec d'une tâche. Valeurs valides : false (par défaut) : Désactive les diagnostics réseau MTR automatiques. true : Active les diagnostics réseau MTR automatiques.	false
diagnosis_ping	boolean	Indique si la détection automatique de la latence réseau Ping doit être activée après l'échec d'une tâche de surveillance. Valeurs valides : false (par défaut) : Désactivée. true : Activée.	false
retry_delay	integer	Le nombre de tentatives après un échec de surveillance.	1
assertions	object
assertions	array<object>	Le groupe de configurations d'assertion.
	object	Le groupe de configurations d'assertion.
property	string	Le chemin d'analyse pour le contenu de l'assertion. Si le type d'assertion est `body_json`, le chemin est un `json path`. Si le type d'assertion est `body_xml`, le chemin est un `xml path`.	json path
type	string	Le type d'assertion. Valeurs valides : response_time : Vérifie si le temps de réponse répond aux attentes. status_code : Vérifie si le code d'état de la réponse HTTP répond aux attentes. header : Vérifie si un champ dans l'en-tête de réponse répond aux attentes. body_text : Vérifie si le contenu du corps de la réponse répond aux attentes par correspondance de chaîne de texte. body_json : Vérifie si le contenu du corps de la réponse répond aux attentes par analyse JSON (JSON Path). body_xml : Vérifie si le contenu du corps de la réponse répond aux attentes par analyse XML (XPath).	response_time
operator	string	L'opérateur de comparaison d'assertion. Valeurs valides : contains : contient. doesNotContain : ne contient pas. matches : correspond à une expression régulière. doesNotMatch : ne correspond pas à une expression régulière. is : égal à (numérique ou chaîne). isNot : différent de. lessThan : inférieur à. moreThan : supérieur à.	lessThan
target	string	La valeur ou la chaîne cible pour la comparaison d'assertion.	1000
AgentGroup	string	Le type de sonde. Valeurs valides : PC : Basé sur PC. MOBILE : Basé sur mobile.	PC

Exemples

JSON format

{
  "RequestId": "A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B",
  "Success": "true",
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "SiteMonitors": {
    "SiteMonitor": [
      {
        "TaskType": "TCP",
        "UpdateTime": "2022-03-08 17:14:31",
        "Interval": "1",
        "TaskState": "1",
        "CreateTime": "2021-11-01 11:05:18",
        "TaskName": "Nouvelle tâche de surveillance",
        "Address": "https://aliyun.com",
        "TaskId": "f5783760-1b39-4b6b-80e8-453d962a****",
        "OptionsJson": {
          "password": "123****",
          "request_format": "hex",
          "response_content": "cf0f85",
          "failure_rate": 0.5,
          "time_out": 3000,
          "header": "testKey:testValue",
          "cookie": "lang=en",
          "port": 80,
          "ping_num": 20,
          "authentication": 1,
          "http_method": "get",
          "match_rule": 0,
          "dns_match_rule": "IN_DNS",
          "request_content": "cf0f85",
          "username": "testUser",
          "response_format": "hex",
          "dns_type": "A",
          "dns_server": "192.168.XX.XX",
          "enable_operator_dns": true,
          "attempts": 3,
          "protocol": "udp",
          "proxy_protocol": false,
          "acceptable_response_code": "400",
          "isBase64Encode": "false",
          "cert_verify": false,
          "unfollow_redirect": false,
          "diagnosis_mtr": false,
          "diagnosis_ping": false,
          "retry_delay": 1,
          "assertions": {
            "assertions": [
              {
                "property": "chemin JSON",
                "type": "response_time",
                "operator": "lessThan",
                "target": "1000"
              }
            ]
          }
        },
        "AgentGroup": "PC"
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidQueryParameter	%s
401	AccessDeniedException	You donot have sufficient access to perform this action.
500	%s	%s
500	InternalError	%s
402	LimitExceeded	The quota for this customer had been reached.
403	Forbidden	You are not authorized to operate the specified resource.	Vous ne disposez pas des autorisations requises. Utilisez RAM pour accorder les autorisations.
503	%s	%s
406	ExceedingQuota	Exceeding quota limits.	Vous avez dépassé le quota de tâches.
429	ThrottlingException	The request was denied due to request throttling.
409	%s	%s

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

Notes de version

Consultez Notes de version pour la liste complète.