DescribeMetricTop - - Centre de documentation Alibaba Cloud

Remarque

Pour connaître les valeurs à attribuer aux paramètres Namespace, Project, Metric, Period et Dimensions des services cloud, consultez

DescribeMetricMetaList

ou

Metrics

.

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	DescribeMetricTop	Opération à effectuer. Définissez la valeur sur DescribeMetricTop.
MetricName	String	Oui	cpu_idle	Nom de la métrique.
Namespace	String	Oui	acs_ecs_dashboard	Namespace du service cloud. Spécifiez la valeur au format acs_nom_du_service.
Orderby	String	Oui	Average	Champ de tri des données de métrique.
Period	String	Non	60	Intervalle de temps des données de métrique interrogées. Unité : secondes. Valeurs valides : 60, 300 et 900. Définissez ce paramètre selon vos besoins. Exemples : Si vous définissez ce paramètre sur 60 et qu'il existe 1 440 entrées de données de métrique, seules les 1 000 premières entrées sont renvoyées. Si vous définissez ce paramètre sur 300 et qu'il existe 288 entrées de données de métrique, toutes les entrées sont renvoyées. Remarque Le nombre maximal d'entrées de données de métrique renvoyées est de 1 000. Si le nombre dépasse 1 000, seules les 1 000 premières entrées sont renvoyées.
StartTime	String	Non	2019-01-30 00:00:00	Début de la plage de temps à interroger. Formats pris en charge : Horodatage UNIX : nombre de millisecondes écoulées depuis le jeudi 1er janvier 1970 à 00:00:00. Format horaire : AAAA-MM-JJThh:mm:ssZ. Remarque La période spécifiée par StartTime et EndTime inclut l'heure spécifiée par EndTime et exclut l'heure spécifiée par StartTime. StartTime doit être antérieur à EndTime.
EndTime	String	Non	2019-01-30 00:10:00	Fin de la plage de temps à interroger. Formats pris en charge : Horodatage UNIX : nombre de millisecondes écoulées depuis le jeudi 1er janvier 1970 à 00:00:00. Format horaire : AAAA-MM-JJThh:mm:ssZ.
Dimensions	String	Non	[{"instanceId": "i-abcdefgh12****"}]	Dimensions spécifiant les ressources pour lesquelles vous souhaitez interroger les données de métrique. Définissez la valeur sous forme de paires clé-valeur. Une paire typique est `instanceId:i-2ze2d6j5uhg20x47**`. Remarque** Les dimensions doivent être formatées sous forme de chaîne JSON dans un ordre spécifique.
OrderDesc	String	Non	False	Méthode de tri des données de métrique. Valeurs valides : True : trie les valeurs par ordre croissant. False : trie les valeurs par ordre décroissant.
Length	String	Non	1000	Nombre d'entrées à renvoyer par page. Valeur par défaut : 1000.
Express	String	Non	{"groupby":["userId","instanceId"]}	Expression de calcul en temps réel appliquée aux résultats de la requête. Seule l'expression `groupby` est prise en charge. Cette expression est similaire à l'instruction GROUP BY utilisée dans les bases de données.

Paramètres de réponse

Paramètre	Type	Exemple	Description
RequestId	String	3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42	ID de la requête.
Code	String	200	Code d'état HTTP. Remarque Le code d'état 200 indique que l'appel a réussi.
Datapoints	String	[{"timestamp":1548777660000,"userId":"123","instanceId":"i-abc","Minimum":9.92,"Average":9.92,"Maximum":9.92,"_count":1}]	Données de la métrique.
Period	String	60	Intervalle de temps des données de métrique interrogées. Unité : secondes. Valeurs valides : 60, 300 et 900.
Message	String	The Request is not authorization.	Message d'erreur.

Exemples

Exemples de requêtes

http(s)://[Endpoint]/? Action=DescribeMetricTop
&MetricName=cpu_idle
&Namespace=acs_ecs_dashboard
&Orderby=Average
&<Common request parameters>

Exemples de réponses réussies

Format XML

<DescribeMetricTopResponse>
	  <Period>60</Period>
	  <Datapoints>
		    <order>1</order>
		    <timestamp>1551687360000</timestamp>
		    <userId>12345****</userId>
		    <instanceId>i-2zeehst1****</instanceId>
		    <Maximum>16.41</Maximum>
		    <Minimum>4.66</Minimum>
		    <Average>7.74</Average>
		    <_count>1</_count>
	  </Datapoints>
	  <Datapoints>
		    <order>2</order>
		    <timestamp>1551687360000</timestamp>
		    <userId>12345****</userId>
		    <instanceId>i-2zefxdy2****</instanceId>
		    <Maximum>15.74</Maximum>
		    <Minimum>5.03</Minimum>
		    <Average>7.14</Average>
		    <_count>1</_count>
	  </Datapoints>
	  <RequestId>1F68A4E8-4488-48E7-9189-3E1F5165E64E</RequestId>
	  <Code>200</Code>
</DescribeMetricTopResponse>

Format JSON

{
    "Period": "60",
    "Datapoints": [
        {
            "order": 1,
            "timestamp": 1551687360000,
            "userId": "12345****",
            "instanceId": "i-2zeehst1****",
            "Maximum": 16.41,
            "Minimum": 4.66,
            "Average": 7.74,
            "_count": 1
        },
        {
            "order": 2,
            "timestamp": 1551687360000,
            "userId": "12345****",
            "instanceId": "i-2zefxdy2****",
            "Maximum": 15.74,
            "Minimum": 5.03,
            "Average": 7.14,
            "_count": 1
        }
    ],
    "RequestId": "1F68A4E8-4488-48E7-9189-3E1F5165E64E",
    "Code": "200"
}

Codes d'erreur

Pour une liste des codes d'erreur, consultez le Centre d'erreurs API.