DescribeSiteMonitorList - - Centre de documentation Alibaba Cloud

Interroge les tâches de surveillance de site.

Cette rubrique explique comment interroger toutes les tâches de surveillance de site associées à votre compte Alibaba Cloud. Dans cet exemple, le résultat indique que le compte dispose d'une tâche nommée HanZhou_ECS2.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. Il 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	DescribeSiteMonitorList	Opération à effectuer. Définissez la valeur sur DescribeSiteMonitorList.
TaskId	String	Non	a1ecd34a-8157-44d9-b060-14950837****	ID de la tâche de surveillance de site.
TaskType	String	Non	HTTP	Protocole utilisé par la tâche de surveillance de site. Valeurs valides : HTTP, PING, TCP, UDP, DNS, SMTP, POP3 et FTP.
Keyword	String	Non	site	Mot-clé à rechercher. Remarque Vous pouvez rechercher des tâches par nom ou par adresse. La recherche floue est prise en charge.
Page	Integer	Non	1	Numéro de page. Valeur par défaut : 1.
PageSize	Integer	Non	10	Nombre d'entrées par page. Valeur par défaut : 10.
TaskState	String	Non	1	État de la tâche. Valeurs valides : 1 : la tâche est activée. 2 : la tâche est désactivée.

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

Paramètres de réponse

Paramètre	Type	Exemple	Description
RequestId	String	A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B	ID de la requête.
Success	String	true	Indique si la requête a abouti. Valeurs valides : true false
Code	String	200	Code d'état. Remarque Le code d'état 200 indique que la requête a abouti.
Message	String	successful	Message renvoyé.
PageNumber	Integer	1	Numéro de page.
PageSize	Integer	10	Nombre d'entrées par page.
TotalCount	Integer	1	Nombre total d'entrées renvoyées.
SiteMonitors	Array of SiteMonitor		Tâches de surveillance de site renvoyées.
SiteMonitor
TaskType	String	TCP	Protocole utilisé par la tâche de surveillance de site. Valeurs valides : HTTP, PING, TCP, UDP, DNS, SMTP, POP3 et FTP.
UpdateTime	String	2022-03-08 17:14:31	Heure de mise à jour de la tâche de surveillance de site.
Interval	String	1	Intervalle d'envoi des requêtes de détection. Unité : minutes.
TaskState	String	1	État de la tâche. Valeurs valides : 1 : la tâche est activée. 2 : la tâche est désactivée.
CreateTime	String	2021-11-01 11:05:18	Heure de création de la tâche de surveillance de site.
TaskName	String	New site monitoring task	Nom de la tâche de surveillance de site.
Address	String	https://aliyun.com	URL ou adresse IP surveillée par la tâche de surveillance de site.
TaskId	String	f5783760-1b39-4b6b-80e8-453d962a****	ID de la tâche de surveillance de site.
OptionsJson	Object		Options étendues de la tâche de surveillance de site. Les options varient selon le protocole spécifié. Pour plus d'informations, consultez CreateSiteMonitor.
password	String	123****	Mot de passe du protocole SMTP, POP3 ou FTP.
request_format	String	hex	Format de la requête HTTP. Valeurs valides : hex : hexadécimal txt : texte
response_content	String	cf0f85	Réponse à la requête HTTP. Format hexadécimal : si le contenu de la requête est une chaîne d'octets non imprimable, convertissez-la en caractères imprimables au format hexadécimal. Un octet devient deux caractères hexadécimaux. Par exemple, (byte)1 devient `01` et (byte)27 devient `1B`. Si le contenu est un tableau binaire Java, par exemple `{(byte)1, (byte)27}`, convertissez-le en `011b` ou `011B`. Les caractères hexadécimaux ne sont pas sensibles à la casse dans les tâches de surveillance de site. Vous pouvez saisir `011B` dans le contenu de la requête et définir le paramètre request_format sur hex. Format texte : le texte courant désigne les chaînes composées de caractères imprimables.
failure_rate	Float	0,5	Taux de perte de paquets. Remarque Ce paramètre n'est renvoyé que si le paramètre TaskType est défini sur PING.
time_out	Long	3000	Délai d'expiration. Unité : millisecondes.
header	String	testKey:testValue	En-tête de la requête HTTP. Un en-tête HTTP est une paire clé-valeur séparée par deux points (:). Le format est `key1:value1`. Chaque en-tête HTTP occupe une ligne.
cookie	String	lang=en	Cookie de la requête HTTP.
port	Integer	80	Numéro de port du protocole TCP, UDP, SMTP ou POP3.
ping_num	Integer	20	Nombre de sauts pour le protocole PING.
authentication	Integer	1	Indique si l'authentification de sécurité est activée. Valeurs valides : 0 : la fonctionnalité est activée. 1 : la fonctionnalité est désactivée.
http_method	String	get	Méthode de requête HTTP. Valeurs valides : get post head
match_rule	Integer	0	Indique si la règle d'alerte est incluse. Valeurs valides : 0 : la règle d'alerte est incluse. 1 : la règle d'alerte n'est pas incluse.
dns_match_rule	String	IN_DNS	Relation entre la liste des alias ou adresses IP attendus et la liste des résultats DNS. Valeurs valides : 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.
request_content	String	cf0f85	Contenu de la requête HTTP.
username	String	testUser	Nom d'utilisateur du protocole FTP, SMTP ou POP3.
response_format	String	hex	Format de la réponse HTTP. Valeurs valides : hex : hexadécimal txt : texte
dns_type	String	A	Type d'enregistrement DNS. Ce paramètre n'est renvoyé que si le paramètre TaskType est défini sur DNS. Valeurs valides : A (par défaut) : enregistrement qui spécifie une adresse IP liée au nom d'hôte ou au nom de domaine spécifié. CNAME : enregistrement qui mappe plusieurs noms de domaine à un nom de domaine. NS : enregistrement qui spécifie un serveur DNS utilisé pour résoudre les noms de domaine. MX : enregistrement qui lie les noms de domaine à l'adresse d'un serveur de messagerie. TXT : enregistrement qui stocke les informations textuelles des noms d'hôte ou de domaine. Le texte doit avoir une longueur comprise entre 1 et 512 octets. L'enregistrement TXT sert d'enregistrement SPF (Sender Policy Framework) pour lutter contre le spam. AAAA : enregistrement qui mappe un nom de domaine à l'adresse IPv6 correspondante.
dns_server	String	192.168.XX.XX	Nom de domaine ou adresse IP du serveur DNS.
enable_operator_dns	Boolean	true	Indique si le serveur DNS de l'opérateur est utilisé. true (par défaut) : le serveur DNS de l'opérateur est utilisé. false : le serveur DNS de l'opérateur n'est pas utilisé. Le serveur DNS par défaut ou le serveur DNS spécifié est utilisé.
attempts	Long	3	Nombre de nouvelles tentatives après un échec DNS.
protocol	String	udp	Type de protocole de détection DNS. Valeurs valides : udp (par défaut) tcp tcp-tls
proxy_protocol	Boolean	false	Indique si le protocole PROXY est activé. Valeurs valides : false (par défaut) : le protocole PROXY est désactivé. true : le protocole PROXY est activé.
acceptable_response_code	String	400	Code d'état acceptable. Remarque Nous vous recommandons de configurer des assertions.
isBase64Encode	String	false	Indique si le mot de passe est décodé à l'aide de l'algorithme Base64. Valeurs valides : true : le mot de passe est décodé à l'aide de l'algorithme Base64. false (par défaut) : le mot de passe n'est pas décodé à l'aide de l'algorithme Base64.
cert_verify	Boolean	false	Indique si le certificat est vérifié. Valeurs valides : false (par défaut) : le certificat n'est pas vérifié. true : le certificat est vérifié.
unfollow_redirect	Boolean	false	Indique si les redirections sont suivies lorsque le code d'état 301 ou 302 est renvoyé. Valeurs valides : true : les redirections ne sont pas suivies. false (par défaut) : les redirections sont suivies.
diagnosis_mtr	Boolean	false	Indique si MTR est automatiquement utilisé pour diagnostiquer les problèmes réseau en cas d'échec d'une tâche. Valeurs valides : false (par défaut) : MTR n'est pas automatiquement utilisé pour diagnostiquer les problèmes réseau en cas d'échec d'une tâche. true : MTR est automatiquement utilisé pour diagnostiquer les problèmes réseau en cas d'échec d'une tâche.
diagnosis_ping	Boolean	false	Indique si des requêtes ping sont automatiquement envoyées pour détecter la latence réseau en cas d'échec d'une tâche de détection. Valeurs valides : false (par défaut) : les requêtes Ping ne sont pas automatiquement envoyées pour détecter la latence réseau en cas d'échec d'une tâche de détection. true : les requêtes Ping sont automatiquement envoyées pour détecter la latence réseau en cas d'échec d'une tâche de détection.
retry_delay	Integer	1	Nombre de nouvelles tentatives pour une requête de détection ayant échoué.
assertions	Array of assertions		Assertions.
assertions
property	String	json path	Chemin d'analyse de l'assertion. Si le type d'assertion est `body_json`, le chemin est `json path`. Si le type d'assertion est `body_xml`, le chemin est `xml path`.
type	String	response_time	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 HTTP répond aux attentes. header : vérifie si les champs de l'en-tête de réponse répondent aux attentes. body_text : vérifie si le contenu du corps de la réponse répond aux attentes par correspondance de texte. body_json : vérifie si le contenu du corps de la réponse répond aux attentes par analyse JSON (JSONPath). body_xml : vérifie si le contenu du corps de la réponse répond aux attentes par analyse XML (XPath).
operator	String	lessThan	Opérateur de comparaison de l'assertion. Valeurs valides : contains : contient doesNotContain : ne contient pas matches : correspond aux expressions régulières doesNotMatch : ne correspond pas aux expressions régulières is : égal à une valeur numérique ou correspond à un caractère isNot : différent de lessThan : inférieur à moreThan : supérieur à
target	String	1000	Valeur numérique ou caractère utilisé pour la correspondance.
AgentGroup	String	PC	Type de sonde. Valeurs valides : PC MOBILE

Exemples

Exemples de requêtes

http(s)://[Endpoint]/?Action=DescribeSiteMonitorList
&<Common request parameters>

Exemples de réponses réussies

XML format

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

<DescribeSiteMonitorListResponse>
    <TotalCount>1</TotalCount>
    <RequestId>A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B</RequestId>
    <Message>successful</Message>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <Code>200</Code>
    <Success>true</Success>
    <SiteMonitors>
        <SiteMonitor>
            <TaskId>f5783760-1b39-4b6b-80e8-453d962a****</TaskId>
            <Address>https://aliyun.com</Address>
            <EndTime></EndTime>
            <TaskName>test123</TaskName>
            <OptionsJson>
                <response_content></response_content>
                <request_format>hex</request_format>
                <response_format>hex</response_format>
                <request_content>cf0f85</request_content>
                <port>80</port>
            </OptionsJson>
            <TaskType>TCP</TaskType>
            <CreateTime>2021-11-01 11:05:18</CreateTime>
            <UpdateTime>2022-03-08 17:14:31</UpdateTime>
            <TaskState>1</TaskState>
            <Interval>1</Interval>
        </SiteMonitor>
    </SiteMonitors>
</DescribeSiteMonitorListResponse>

JSON format

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

{
  "TotalCount" : 1,
  "RequestId" : "A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B",
  "Message" : "successful",
  "PageSize" : 10,
  "PageNumber" : 1,
  "Code" : "200",
  "Success" : true,
  "SiteMonitors" : {
    "SiteMonitor" : [ {
      "TaskId" : "f5783760-1b39-4b6b-80e8-453d962a****",
      "Address" : "https://aliyun.com",
      "EndTime" : "",
      "TaskName" : "test123",
      "OptionsJson" : {
        "response_content" : "",
        "request_format" : "hex",
        "response_format" : "hex",
        "request_content" : "cf0f85",
        "port" : 80
      },
      "TaskType" : "TCP",
      "CreateTime" : "2021-11-01 11:05:18",
      "UpdateTime" : "2022-03-08 17:14:31",
      "TaskState" : 1,
      "Interval" : 1
    } ]
  }
}

Codes d'erreur

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