DescribeMetricList - - Centre de documentation Alibaba Cloud

Description de l'opération

Limites

Vous disposez d'un quota gratuit de 1 million d'appels d'API au total par mois pour les opérations DescribeMetricLast, DescribeMetricList, DescribeMetricData et DescribeMetricTop. Si vous épuisez le quota gratuit et que vous n'avez pas activé le mode de facturation à l'usage pour CloudMonitor Basic, vous ne pouvez plus utiliser ces opérations d'API. Si vous avez activé le mode de facturation à l'usage, vous pouvez continuer à utiliser les opérations d'API après l'épuisement du quota gratuit. Les appels d'API qui dépassent le quota gratuit sont automatiquement facturés à l'usage. Pour plus d'informations, consultez Activer la facturation à l'usage.
Vous pouvez appeler chaque opération d'API jusqu'à 50 fois par seconde. Cette limite est partagée entre un compte Alibaba Cloud et ses utilisateurs RAM.

Remarque

Si vous recevez le message d'erreur Throttling.User ou Request was denied due to user flow control lors de l'appel d'une opération d'API, l'appel d'API est limité. Pour plus d'informations, consultez Comment résoudre un problème de limitation des appels d'API ?.

Remarques

La durée de conservation des données de surveillance pour un service cloud dépend de la valeur de Period (période statistique). Une valeur de Period plus élevée indique que les données de surveillance sont moins granulaires et sont conservées pendant une période plus longue. La relation est la suivante :

Si la valeur de Period est inférieure à 60 secondes, la durée de conservation est de 7 jours.
Si la valeur de Period est de 60 secondes, la durée de conservation est de 31 jours.
Si la valeur de Period est de 300 secondes ou plus, la durée de conservation est de 91 jours.

Notes d'utilisation

Cette rubrique fournit un exemple de requête des données de surveillance de la métrique cpu_idle pour le service cloud acs_ecs_dashboard. La réponse affiche les données de l'instance i-abcdefgh12****, qui appartient au compte Alibaba Cloud 120886317861****. À un intervalle de 60 secondes, les valeurs maximale, minimale et moyenne de la métrique sont respectivement de 100, 93,1 et 99,52.

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

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Namespace	string	Oui	L'espace de noms du service cloud. Pour plus d'informations, consultez Métriques.	acs_ecs_dashboard
MetricName	string	Oui	Le nom de la métrique. Pour plus d'informations, consultez Métriques.	cpu_idle
Period	string	Non	La période statistique des données de surveillance. Valeurs valides : 15, 60, 900 et 3600. Unité : secondes. Remarque Si vous ne définissez pas ce paramètre, la période de rapport spécifiée lors de l'enregistrement de la métrique est utilisée. La période statistique de chaque métrique (MetricName) d'un service cloud est différente. Pour plus d'informations, consultez Métriques.	60
StartTime	string	Non	Le début de la plage de temps à 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. Format : AAAA-MM-JJ hh:mm:ss. Remarque La plage de temps est un intervalle ouvert à gauche et fermé à droite. La valeur de StartTime doit être antérieure à la valeur de EndTime. L'intervalle entre StartTime et EndTime doit être inférieur ou égal à 31 jours.	2019-01-30 00:00:00
EndTime	string	Non	La fin de la plage de temps à 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. Format : AAAA-MM-JJ hh:mm:ss. Remarque L'intervalle entre StartTime et EndTime doit être inférieur ou égal à 31 jours.	2019-01-30 00:10:00
Dimensions	string	Non	Les dimensions qui spécifient les ressources à surveiller. Format : une collection de paires clé-valeur, telles que {"userId":"120886317861**"} et {"instanceId":"i-2ze2d6j5uhg20x47"}. Remarque** Une seule requête peut être utilisée pour interroger un maximum de 50 instances.	[{"instanceId":"i-2ze2d6j5uhg20x47****"}]
NextToken	string	Non	Le curseur de pagination. Remarque Si vous ne définissez pas ce paramètre, la première page de données est renvoyée. Si une valeur est renvoyée pour ce paramètre, cela indique que davantage de données sont disponibles. Pour récupérer la page suivante, utilisez la valeur renvoyée comme NextToken dans votre requête suivante. Une valeur nulle indique que toutes les données ont été récupérées.	15761485350009dd70bb64cff1f0fff750b08ffff073be5fb1e785e2b020f1a949d5ea14aea7fed82f01dd8****
Length	string	Non	Le nombre d'entrées à renvoyer sur chaque page pour une requête paginée. Remarque La valeur maximale de Length dans une seule requête est de 1440.	1000
Express	string	Non	L'expression utilisée pour le calcul en temps réel basé sur les résultats de la requête. Remarque Seule l'expression groupby est prise en charge. Cette expression est similaire à l'instruction GROUP BY 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
NextToken	string	Le curseur de pagination.	15761441850009dd70bb64cff1f0fff6d0b08ffff073be5fb1e785e2b020f7fed9b5e137bd810a6d6cff5ae****
RequestId	string	L'identifiant de la requête.	3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42
Success	boolean	Indique si l'opération a réussi. Valeurs valides : true : l'opération a réussi. false : l'opération a échoué.	true
Datapoints	string	La liste des données de surveillance.	[{"timestamp":1548777660000,"userId":"120886317861****","instanceId":"i-abc","Minimum":9.92,"Average":9.92,"Maximum":9.92}]
Code	string	Le code d'état. Remarque Une valeur de 200 indique que l'appel a réussi.	200
Message	string	Le message d'erreur.	La ressource spécifiée est introuvable
Period	string	La période statistique. Unité : secondes. Valeurs valides : 60, 300 et 900.	60

Exemples

JSON format

{
  "NextToken": "15761441850009dd70bb64cff1f0fff6d0b08ffff073be5fb1e785e2b020f7fed9b5e137bd810a6d6cff5ae****",
  "RequestId": "3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42",
  "Success": true,
  "Datapoints": "[{\"timestamp\":1548777660000,\"userId\":\"120886317861****\",\"instanceId\":\"i-abc\",\"Minimum\":9.92,\"Average\":9.92,\"Maximum\":9.92}]",
  "Code": "200",
  "Message": "The specified resource is not found.",
  "Period": "60"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	%s	%s
500	InternalError	The request processing has failed due to some unknown error.
403	%s	%s
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.