DescribeMetricTop - - Centre de documentation Alibaba Cloud

Consulte les dernières données de surveillance d'une métrique pour un service cloud. Les données peuvent être triées selon un ordre spécifié.

Description de l'opération

Limites

Le quota gratuit total est de 1 million d'appels par mois pour les opérations DescribeMetricLast, DescribeMetricList, DescribeMetricData et DescribeMetricTop. Si le quota gratuit est épuisé et que CloudMonitor Basic (prépayé) n'est pas activé, ces opérations d'API ne peuvent plus être appelées comme prévu. Si vous avez activé CloudMonitor Basic (prépayé), ces opérations d'API peuvent toujours être appelées même si le quota gratuit est épuisé. Une fois le quota gratuit épuisé, l'utilisation excédentaire est facturée selon le mode de facturation à l'usage. Pour plus d'informations sur l'activation de CloudMonitor Basic (prépayé), consultez Activer le mode de facturation à l'usage.
Chaque opération d'API peut être appelée jusqu'à 10 fois par seconde. Un compte Alibaba Cloud et les utilisateurs Resource Access Management (RAM) au sein du compte partagent ce quota.

Précautions

La durée de conservation des données de surveillance de chaque service cloud dépend du paramètre Period (période statistique). Une valeur plus élevée du paramètre Period indique que les données de surveillance sont réparties sur une plage de temps plus large et que la durée de conservation des données de surveillance est plus longue. La liste suivante décrit les relations spécifiques :

La durée de conservation est de 7 jours si la valeur du paramètre Period est inférieure à 60 secondes.
La durée de conservation est de 31 jours si la valeur du paramètre Period est de 60 secondes.
La durée de conservation est de 91 jours si la valeur du paramètre Period est supérieure ou égale à 300 secondes.

Description de l'opération

Cette rubrique fournit un exemple de requête des données de surveillance de la métrique cpu_idle au cours des 60 dernières secondes pour Elastic Compute Service (ECS). L'espace de noms d'ECS est acs_ecs_dashboard. Les données de surveillance sont triées par ordre décroissant en fonction du champ Average.

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

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Period	string	Non	La période statistique des données de surveillance. Valeurs valides : 15, 60, 900 et 3600. Unité : secondes. Remarque Si ce paramètre n'est pas spécifié, les données de surveillance sont interrogées en fonction de la période pendant laquelle les valeurs de métrique sont signalées. Les périodes statistiques varient en fonction des métriques spécifiées par `MetricName`. Pour plus d'informations, consultez Annexe 1 : Métriques.	60
Namespace	string	Oui	L'espace de noms du service cloud. Pour plus d'informations sur les espaces de noms des services cloud, consultez Annexe 1 : Métriques.	acs_ecs_dashboard
MetricName	string	Oui	La métrique utilisée pour surveiller le service cloud. Pour plus d'informations sur les noms des métriques, consultez Annexe 1 : Métriques.	cpu_idle
StartTime	string	Non	Le début de la plage de temps pour interroger les données de surveillance. Si les paramètres `StartTime` et `EndTime` ne sont pas spécifiés, les données de surveillance de la dernière période statistique sont interrogées.`` Si les paramètres `StartTime` et `EndTime` sont spécifiés, les données de surveillance de la dernière période statistique dans la plage de temps spécifiée sont interrogées.```` Si vous définissez le paramètre `Period` sur 15, la plage de temps spécifiée doit être inférieure ou égale à 20 minutes. Par exemple, si vous définissez le paramètre StartTime sur 2021-05-08 08:10:00 et le paramètre EndTime sur 2021-05-08 08:30:00, les données de surveillance des 15 dernières secondes dans la plage de temps sont interrogées. Si vous définissez le paramètre `Period` sur 60 ou 900, la plage de temps spécifiée doit être inférieure ou égale à 2 heures. Par exemple, si vous définissez le paramètre Period sur 60, le paramètre StartTime sur 2021-05-08 08:00:00 et le paramètre EndTime sur 2021-05-08 10:00:00, les données de surveillance des 60 dernières secondes dans la plage de temps sont interrogées. Si vous définissez le paramètre `Period` sur 3600, la plage de temps spécifiée doit être inférieure ou égale à deux jours. Par exemple, si vous définissez le paramètre StartTime sur 2021-05-08 08:00:00 et le paramètre EndTime sur 2021-05-10 08:00:00, les données de surveillance des 3 600 dernières secondes dans la plage de temps sont interrogées. Les formats suivants sont pris en charge : Horodatage UNIX : le nombre de millisecondes écoulées depuis le jeudi 1er janvier 1970 à 00:00:00 Format de l'heure : YYYY-MM-DDThh:mm:ssZ Remarque Vous devez définir le paramètre `StartTime` sur une heure postérieure au jeudi 1er janvier 1970 à 00:00:00. Sinon, ce paramètre n'est pas valide. Nous vous recommandons d'utiliser des horodatages UNIX pour éviter les problèmes liés aux fuseaux horaires.	2021-05-08 08:00:00
EndTime	string	Non	La fin de la plage de temps pour interroger les données de surveillance. Si les paramètres `StartTime` et `EndTime` ne sont pas spécifiés, les données de surveillance de la dernière période statistique sont interrogées.`` Si les paramètres `StartTime` et `EndTime` sont spécifiés, les données de surveillance de la dernière période statistique dans la plage de temps spécifiée sont interrogées.```` Si vous définissez le paramètre `Period` sur 15, la plage de temps spécifiée doit être inférieure ou égale à 20 minutes. Par exemple, si vous définissez le paramètre StartTime sur 2021-05-08 08:10:00 et le paramètre EndTime sur 2021-05-08 08:30:00, les données de surveillance des 15 dernières secondes dans la plage de temps sont interrogées. Si vous définissez le paramètre `Period` sur 60 ou 900, la plage de temps spécifiée doit être inférieure ou égale à 2 heures. Par exemple, si vous définissez le paramètre Period sur 60, le paramètre StartTime sur 2021-05-08 08:00:00 et le paramètre EndTime sur 2021-05-08 10:00:00, les données de surveillance des 60 dernières secondes dans la plage de temps sont interrogées. Si vous définissez le paramètre `Period` sur 3600, la plage de temps spécifiée doit être inférieure ou égale à deux jours. Par exemple, si vous définissez le paramètre StartTime sur 2021-05-08 08:00:00 et le paramètre EndTime sur 2021-05-10 08:00:00, les données de surveillance des 3 600 dernières secondes dans la plage de temps sont interrogées. Les formats suivants sont pris en charge : Horodatage UNIX : le nombre de millisecondes écoulées depuis le jeudi 1er janvier 1970 à 00:00:00 Format de l'heure : YYYY-MM-DDThh:mm:ssZ Remarque Nous vous recommandons d'utiliser des horodatages UNIX pour éviter les problèmes liés aux fuseaux horaires.	2021-05-08 10:00:00
Dimensions	string	Non	Les dimensions de surveillance de la ressource spécifiée. Définissez la valeur sur une collection de paires `clé:valeur`. Exemple : `{"userId":"120886317861**"}` ou `{"instanceId":"i-2ze2d6j5uhg20x47"}`. Remarque** Vous pouvez interroger un maximum de 50 instances par requête.	[{"instanceId": "i-2ze2d6j5uhg20x47****"}]
Orderby	string	Oui	Le champ en fonction duquel les données sont triées. Valeurs valides : Average Minimum Maximum	Average
OrderDesc	string	Non	L'ordre dans lequel les données sont triées. Valeurs valides : True : trie les données par ordre croissant. False (par défaut) : trie les données par ordre décroissant.	false
Length	string	Non	Le nombre d'entrées par page. Valeur par défaut : 10. Remarque La valeur maximale du paramètre Length dans une requête est de 1440.	10
Express	string	Non	L'expression utilisée pour calculer les résultats de la requête en temps réel. Remarque Seule l'expression `groupby` est prise en charge. Cette expression est similaire à l'instruction GROUP BY utilisée dans les bases de données.	{"groupby":["userId","instanceId"]}

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
Code	string	Le code d'état HTTP. Remarque Le code d'état 200 indique que la requête a réussi.	200
Message	string	Le message d'erreur.	La ressource spécifiée est introuvable
RequestId	string	L'identifiant de la requête.	3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42
Datapoints	string	Les données de surveillance.	[{\"order\":1,\"timestamp\":1620287520000,\"userId\":\"120886317861**\",\"instanceId\":\"i-j6ccf7d5fn335qpo\",\"Average\":99.92,\"Minimum\":99.5,\"Maximum\":100.0,\"_count\":1.0},{\"order\":2,\"timestamp\":1620287520000,\"userId\":\"120886317861\",\"instanceId\":\"i-0xii2bvf42iqvxbp**\",\"Average\":99.91,\"Minimum\":99.0,\"Maximum\":100.0,\"_count\":1.0}]
Period	string	La période statistique des données de surveillance. Unité : secondes. Valeurs valides : 15, 60, 900 et 3600.	60

Exemples

JSON format

{
  "Code": "200",
  "Message": "The specified resource is not found.",
  "RequestId": "3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42",
  "Datapoints": "[{\\\"order\\\":1,\\\"timestamp\\\":1620287520000,\\\"userId\\\":\\\"120886317861****\\\",\\\"instanceId\\\":\\\"i-j6ccf7d5fn335qpo****\\\",\\\"Average\\\":99.92,\\\"Minimum\\\":99.5,\\\"Maximum\\\":100.0,\\\"_count\\\":1.0},{\\\"order\\\":2,\\\"timestamp\\\":1620287520000,\\\"userId\\\":\\\"120886317861****\\\",\\\"instanceId\\\":\\\"i-0xii2bvf42iqvxbp****\\\",\\\"Average\\\":99.91,\\\"Minimum\\\":99.0,\\\"Maximum\\\":100.0,\\\"_count\\\":1.0}]",
  "Period": "60"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	ParameterInvalid	Illegal parameters.
500	InternalError	The request processing has failed due to some unknown error.
403	AccessForbidden	User not authorized to operate on the specified resource.
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.

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

Notes de version

Consultez Notes de version pour la liste complète.