DescribeSiteMonitorAttribute - - Centre de documentation Alibaba Cloud

Cette rubrique présente un exemple d'interrogation des détails d'une tâche de surveillance de site dont l'ID est cc641dff-c19d-45f3-ad0a-818a0c4f****. Le résultat indique que le nom de la tâche est test123, l'adresse surveillée est https://aliyun.com, et le nom du fournisseur d'accès Internet est Alibaba.

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	DescribeSiteMonitorAttribute	Opération à effectuer. Définissez la valeur sur DescribeSiteMonitorAttribute.
TaskId	String	Oui	cc641dff-c19d-45f3-ad0a-818a0c4f****	ID de la tâche de surveillance de site.
IncludeAlert	Boolean	Non	false	Indique si les informations des règles d'alerte configurées pour la tâche de surveillance de site doivent être renvoyées. Valeurs valides : true : le système renvoie les informations des règles d'alerte configurées pour la tâche de surveillance de site. false : le système ne renvoie pas les informations des règles d'alerte. Valeur par défaut : false.

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	D17DF650-7EBD-54D0-903A-1D4E624D7402	ID de la requête.
Code	String	200	Code d'état HTTP. Remarque Le code 200 indique que l'appel a réussi.
Success	Boolean	true	Indique si l'appel a réussi. Valeurs valides : true : l'appel a réussi. false : l'appel a échoué.
SiteMonitors	Struct		Détails de la tâche de surveillance de site.
Address	String	https://aliyun.com	Adresse surveillée par la tâche de surveillance de site.
Interval	String	1	Intervalle d'exécution de la tâche de surveillance de site. Unité : minutes. Valeurs valides : 1, 5, 15, 30 et 60.
IspCities	Array of IspCity		Informations sur les points de détection, y compris les fournisseurs d'accès Internet qui les hébergent et les villes où ils se trouvent.
IspCity
City	String	738	ID de la ville.
CityName	String	Beijing	Nom de la ville.
Isp	String	465	ID du fournisseur d'accès Internet.
IspName	String	Alibaba	Nom du fournisseur d'accès Internet.
OptionJson	Struct		Options étendues de la tâche de surveillance de site. Les options varient selon le protocole spécifié. Pour plus d'informations, consultez CreateSiteMonitor.
attempts	Long	3	Nombre de tentatives après un échec DNS.
authentication	Integer	1	Indique si la fonction d'authentification de sécurité est activée. Valeurs valides : 0 : la fonction d'authentification de sécurité est désactivée. 1 : la fonction d'authentification de sécurité est activée.
cookie	String	lang=en	Cookie de la requête HTTP.
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.
dns_server	String	192.168.XX.XX	Adresse IP du serveur DNS. Remarque Ce paramètre est renvoyé uniquement si le paramètre TaskType est défini sur DNS.
dns_type	String	A	Type d'enregistrement DNS. Ce paramètre est renvoyé uniquement si le paramètre TaskType est défini sur DNS. Valeurs valides : A : nom par défaut. Indique un enregistrement spécifiant une adresse IP liée au nom d'hôte ou au nom de domaine spécifié. CNAME : enregistrement mappant plusieurs noms de domaine à un nom de domaine. NS : enregistrement spécifiant un serveur DNS utilisé pour résoudre les noms de domaine. MX : enregistrement liant les noms de domaine à l'adresse d'un serveur de messagerie. TXT : enregistrement stockant 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.
expect_value	String	dns_server	Nom de domaine ou alias à résoudre. Remarque Ce paramètre est renvoyé uniquement si le paramètre TaskType est défini sur DNS.
failure_rate	Float	0.4	Taux de perte de paquets. Remarque Ce paramètre est renvoyé uniquement si le paramètre TaskType est défini sur PING.
header	String	testKey:testValue	En-tête de la requête HTTP.
http_method	String	get	Méthode de requête HTTP. Valeurs valides : get post head
isBase64Encode	String	true	Indique si la valeur du paramètre `password` est encodée en Base64. true : la valeur du paramètre password est encodée en Base64. false : la valeur du paramètre password n'est pas encodée en Base64.
match_rule	Integer	1	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.
password	String	123****	Mot de passe du protocole SMTP, POP3 ou FTP.
ping_num	Integer	29	Signal de maintien actif (heartbeat) du protocole PING.
port	Integer	110	Numéro de port du protocole TCP, UDP, SMTP ou POP3.
protocol	String	TCP	Protocole utilisé pour envoyer la requête.
request_content	String	aa=bb	Contenu de la requête HTTP.
request_format	String	txt	Format de la requête HTTP. Valeurs valides : hex : hexadécimal txt : texte
response_content	String	txt	Réponse à la requête HTTP.
response_format	String	txt	Format de la réponse. Valeurs valides : hex : hexadécimal txt : texte
time_out	Long	3	Délai d'expiration. Unité : millisecondes.
username	String	testUser	Nom d'utilisateur du protocole FTP, SMTP ou POP3.
TaskId	String	cc641dff-c19d-45f3-ad0a-818a0c4f****	ID de la tâche de surveillance de site.
TaskName	String	test123	Nom de la tâche de surveillance de site.
TaskState	String	1	État de la tâche de surveillance de site. Valeurs valides : 1 : la tâche est activée. 2 : la tâche est désactivée.
TaskType	String	HTTP	Protocole utilisé par la tâche de surveillance de site. Valeurs valides : HTTP, HTTPS, PING, TCP, UDP, DNS, SMTP, POP3 et FTP.
MetricRules	Array of MetricRule		Informations sur les règles d'alerte configurées pour la tâche de surveillance de site.
MetricRule
ActionEnable	String	true	Indique si la règle d'alerte est activée. Valeurs valides : true : la règle d'alerte est activée. false : la règle d'alerte est désactivée.
AlarmActions	String	CloudMonitor	Groupe de contacts d'alerte auquel les notifications d'alerte sont envoyées.
ComparisonOperator	String	GreaterThanYesterday	Opérateur de comparaison utilisé dans la règle d'alerte. Valeurs valides : `>=` `>` `<=` `<` `=` `!=` GreaterThanYesterday : supérieur à la valeur de métrique à la même heure la veille LessThanYesterday : inférieur à la valeur de métrique à la même heure la veille GreaterThanLastWeek : supérieur à la valeur de métrique à la même heure la semaine précédente LessThanLastWeek : inférieur à la valeur de métrique à la même heure la semaine précédente GreaterThanLastPeriod : supérieur à la valeur de métrique du dernier cycle de surveillance LessThanLastPeriod : inférieur à la valeur de métrique du dernier cycle de surveillance
Dimensions	String	[{"taskId": "cc641dff-c19d-45f3-ad0a-818a0c4f****" }]	Dimension de la règle d'alerte.
EvaluationCount	String	3	Nombre consécutif de mesures de la valeur de métrique avant le déclenchement d'une alerte.
Expression	String	$Availability=30	Expression utilisée pour déclencher les alertes.
Level	String	2	Gravité de l'alerte. Valeurs valides : 1 : critique 2 : avertissement 3 : information
MetricName	String	Availability	Nom de la métrique.
Namespace	String	acs_networkmonitor	Namespace du service cloud.
OkActions	String	[ "CloudMonitor"]	Groupes de contacts d'alerte auxquels les notifications d'alerte sont envoyées.
Period	String	15s	Intervalle d'interrogation des données de surveillance. La valeur correspond à l'intervalle de rapport des données de métrique. Unité : secondes. Remarque Si vous spécifiez une période statistique pour la règle d'alerte, les données brutes sont interrogées en fonction de cette période.
RuleId	String	bf071ae_7b7aec3817b0fdf****	ID de la règle d'alerte.
RuleName	String	rule1	Nom de la règle d'alerte.
StateValue	String	OK	État de l'alerte. Valeurs valides : OK : normal. ALARM : l'alerte est déclenchée.
Statistics	String	Availability	Méthode statistique de la règle d'alerte. Valeurs valides : Availability : pourcentage de points de détection disponibles AvailableNumber : nombre de points de détection disponibles ErrorCodeMaximum : code d'état pour une alerte ErrorCodeMinimum : tous les codes d'état pour un ensemble d'alertes Average : temps de réponse
Threshold	String	30	Seuil d'alerte.
Message	String	successful	Message renvoyé.

Exemples

Exemples de requêtes

http(s)://[Endpoint]/?Action=DescribeSiteMonitorAttribute
&TaskId=cc641dff-c19d-45f3-ad0a-818a0c4f****
&<Common request parameters>

Exemples de réponses réussies

Format XML

<DescribeSiteMonitorAttributeResponse>
	  <MetricRules>
		    <MetricRule>
			      <ComparisonOperator>GreaterThanYesterday</ComparisonOperator>
			      <RuleId>bf071ae_7b7aec3817b0fdf****</RuleId>
			      <Period>15s</Period>
			      <EvaluationCount>3</EvaluationCount>
			      <Dimensions>
				        <taskId>cc641dff-c19d-45f3-ad0a-818a0c4f****</taskId>
			      </Dimensions>
			      <Statistics>Availability</Statistics>
			      <Namespace>acs_networkmonitor</Namespace>
			      <AlarmActions>CloudMonitor</AlarmActions>
			      <MetricName>Availability</MetricName>
			      <OkActions>CloudMonitor</OkActions>
			      <Expression>$Availability=30</Expression>
			      <ActionEnable>true</ActionEnable>
			      <StateValue>OK</StateValue>
			      <Level>2</Level>
			      <RuleName>rule1</RuleName>
			      <Threshold>30</Threshold>
		    </MetricRule>
	  </MetricRules>
	  <Message>successful</Message>
	  <RequestId>D17DF650-7EBD-54D0-903A-1D4E624D7402</RequestId>
	  <Code>200</Code>
	  <Success>true</Success>
	  <SiteMonitors>
		    <OptionJson>
			      <time_out>30000</time_out>
			      <http_method>get</http_method>
		    </OptionJson>
		    <TaskId>cc641dff-c19d-45f3-ad0a-818a0c4f****</TaskId>
		    <Address>https://aliyun.com</Address>
		    <TaskName>test123</TaskName>
		    <TaskType>HTTP</TaskType>
		    <IspCities>
			      <IspCity>
				        <IspName>Alibaba</IspName>
				        <Isp>465</Isp>
				        <CityName>Beijing</CityName>
				        <City>738</City>
			      </IspCity>
		    </IspCities>
		    <TaskState>1</TaskState>
		    <Interval>1</Interval>
	  </SiteMonitors>
</DescribeSiteMonitorAttributeResponse>

Format JSON

{
    "MetricRules": {
        "MetricRule": [
            {
                "ComparisonOperator": "GreaterThanYesterday",
                "RuleId": "bf071ae_7b7aec3817b0fdf****",
                "Period": "15s",
                "EvaluationCount": 3,
                "Dimensions": [
                    {
                        "taskId": "cc641dff-c19d-45f3-ad0a-818a0c4f****"
                    }
                ],
                "Statistics": "Availability",
                "Namespace": "acs_networkmonitor",
                "AlarmActions": [
                    "CloudMonitor"
                ],
                "MetricName": "Availability",
                "OkActions": [
                    "CloudMonitor"
                ],
                "Expression": "$Availability=30",
                "ActionEnable": true,
                "StateValue": "OK",
                "Level": 2,
                "RuleName": "rule1",
                "Threshold": "30"
            }
        ]
    },
    "Message": "successful",
    "RequestId": "D17DF650-7EBD-54D0-903A-1D4E624D7402",
    "Code": "200",
    "Success": true,
    "SiteMonitors": {
        "OptionJson": {
            "time_out": 30000,
            "http_method": "get"
        },
        "TaskId": "cc641dff-c19d-45f3-ad0a-818a0c4f****",
        "Address": "https://aliyun.com",
        "TaskName": "test123",
        "TaskType": "HTTP",
        "IspCities": {
            "IspCity": [
                {
                    "IspName": "Alibaba",
                    "Isp": "465",
                    "CityName": "Beijing",
                    "City": "738"
                }
            ]
        },
        "TaskState": 1,
        "Interval": 1
    }
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, visitez le Centre d'erreurs API.