DescribeSiteMonitorData - - Centre de documentation Alibaba Cloud

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

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
TaskId	string	Oui	L'identifiant de la tâche.	49f7b317-7645-4cc9-94fd-ea42e522****
Type	string	Non	Le type de l'objet surveillé dont les données de surveillance doivent être interrogées. Valeurs valides : metric event	metric
MetricName	string	Oui	Le nom de la métrique. Valeurs valides : Availability ResponseTime	Availability
StartTime	string	Non	Le début de la plage horaire à interroger. Les formats suivants sont pris en charge : Horodatage UNIX : le nombre de millisecondes écoulées depuis le 1er janvier 1970 à 00:00:00 UTC. Heure UTC : l'heure UTC au format AAAA-MM-JJThh:mm:ssZ.	1551579637000
EndTime	string	Non	La fin de la plage horaire à interroger. Les formats suivants sont pris en charge : Horodatage UNIX : le nombre de millisecondes écoulées depuis le 1er janvier 1970 à 00:00:00 UTC. Heure UTC : l'heure UTC au format AAAA-MM-JJThh:mm:ssZ.	1551581437000
Period	string	Non	La période statistique. La valeur est un multiple entier de 60. Unité : secondes. Remarque La valeur par défaut correspond à l'intervalle minimum auquel les requêtes de détection sont envoyées à l'adresse surveillée.	60
NextToken	string	Non	Le jeton de pagination.	49f7b317-7645-4cc9-94fd-ea42e5220930ea42e5220930ea42e522****
Length	integer	Non	Le nombre de points de données à renvoyer.	1000

Éléments de réponse

Élément	Type	Description	Exemple
	object
NextToken	string	Le jeton de pagination.	ea42e5220930ea42e522****
Data	string	Les données de surveillance.	[{"Maximum":247,"Mimimum":61,"Average":154,"userId":"127067667954**","taskId":"49f7b317-7645-4cc9-94fd-ea42e522**","timestamp":1551581760000}]
RequestId	string	L'identifiant de la requête.	3febb181-0d98-4af9-8b04-7faf36b048b9
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
Code	string	Le code de réponse. Remarque Le code d'état 200 indique que la requête a réussi.	200
Message	string	Le message renvoyé.	Successful

Les données renvoyées contiennent une chaîne JSON qui peut comprendre plusieurs ou la totalité des paramètres suivants :

Error4XXRate : le pourcentage de résultats de détection avec des codes d'état 4XX.
Error6XXRate : le pourcentage de résultats de détection avec des codes d'état 6XX.
Error5XXRate : le pourcentage de résultats de détection avec des codes d'état 5XX.
Error4XXNumber : le nombre de résultats de détection avec des codes d'état 4XX.
Error5XXNumber : le nombre de résultats de détection avec des codes d'état 5XX.
Error6XXNumber : le nombre de résultats de détection avec des codes d'état 6XX.
Over5totalTime : le pourcentage de requêtes de détection dont le temps de réponse dépasse 5 000 ms.
Over3totalTime : le pourcentage de requêtes de détection dont le temps de réponse dépasse 3 000 ms.
Over2totalTime : le pourcentage de requêtes de détection dont le temps de réponse dépasse 2 000 ms.
Over10FailureRate : le pourcentage de points de détection dont le taux d'échec des requêtes de détection dépasse 10 %.
Over100FailureRate : le pourcentage de points de détection dont le taux d'échec des requêtes de détection dépasse 99 %.
Over30FailureRate : le pourcentage de points de détection dont le taux d'échec des requêtes de détection dépasse 30 %.
Over50FailureRate : le pourcentage de points de détection dont le taux d'échec des requêtes de détection dépasse 50 %.
Over80FailureRate : le pourcentage de points de détection dont le taux d'échec des requêtes de détection dépasse 80 %.
Over90FailureRate : le pourcentage de points de détection dont le taux d'échec des requêtes de détection dépasse 90 %.
Over400NumberRate : le pourcentage de résultats de détection avec des codes d'état supérieurs à 400.
Over400NumberRate : le pourcentage de résultats de détection avec des codes d'état supérieurs à 500.
AvailableNumber : le nombre de points de détection disponibles.
UnavailableNumber : le nombre de points de détection indisponibles.
Availability : le taux de disponibilité.
Unavailability : le taux d'indisponibilité.
ErrorCodeMaximum : le code d'erreur maximum dans les résultats de détection renvoyés au cours d'une période spécifique. Supposons que cinq codes d'état soient renvoyés en une minute après l'envoi de requêtes de détection depuis cinq points de détection. Le code d'état de quatre résultats de détection est 200 et celui d'un résultat de détection est 404. Dans ce cas, le code d'erreur maximum est 404.
ErrorCodeMinimum : le code d'erreur minimum dans les résultats de détection renvoyés au cours d'une période de surveillance. Supposons que cinq codes d'état soient renvoyés en une minute après l'envoi de requêtes de détection depuis cinq points de détection. Le code d'état de quatre résultats de détection est 200 et celui d'un résultat de détection est 404. Dans ce cas, le code d'erreur minimum est 200.

Remarque

Nous vous recommandons d'utiliser la métrique AvailableNumber, UnavailableNumber, Availability, Unavailability, ErrorCodeMaximum ou ErrorCodeMinimum, dont la valeur est facile à calculer.

Exemples

JSON format

{
  "NextToken": "ea42e5220930ea42e522****",
  "Data": "[{\"Maximum\":247,\"Mimimum\":61,\"Average\":154,\"userId\":\"127067667954****\",\"taskId\":\"49f7b317-7645-4cc9-94fd-ea42e522****\",\"timestamp\":1551581760000}]",
  "RequestId": "3febb181-0d98-4af9-8b04-7faf36b048b9",
  "Success": "true",
  "Code": "200",
  "Message": "Successful"
}

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	InternalError	%s
402	LimitExceeded	The quota for this customer had been reached.
403	Forbidden	You are not authorized to operate the specified resource.	No permission, please use RAM to authorize
503	%s	%s
406	ExceedingQuota	Exceeding quota limits.	The number of tasks exceeds the limit
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.