DescribeInstanceMonitorData - Elastic Compute Service - Centre de documentation Alibaba Cloud

Consulte les données de surveillance d'une instance ECS. Les métriques que vous pouvez consulter incluent l'utilisation du vCPU, les crédits d'instance burstable, le trafic de données entrant, le trafic de données sortant et la bande passante moyenne de l'instance ECS.

Description de l'opération

Prenez note des éléments suivants lors de l'appel de cette opération :

Un maximum de 400 entrées de données peut être renvoyé à la fois. Assurez-vous que la valeur de (EndTime – StartTime)/Period est inférieure ou égale à 400. En d'autres termes, la valeur du paramètre de réponse TotalCount ne peut pas dépasser 400. Sinon, l'erreur InvalidParameter.TooManyDataQueried est renvoyée.
Vous pouvez interroger les données de surveillance des 30 derniers jours. La valeur du paramètre StartTime ne peut pas être antérieure de plus de 30 jours à la date actuelle.
Si du contenu manque dans la réponse, il se peut que le système n'ait pas obtenu les informations correspondantes. Par exemple, l'instance était dans l'état Stopped à ce moment-là.
Cette opération ne peut pas récupérer les données de surveillance de base du processeur des instances ECS Bare Metal. Vous pouvez installer l'agent CloudMonitor pour obtenir les données de surveillance du processeur. Pour plus d'informations, consultez Installer l'agent CloudMonitor.

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.

ecs:DescribeInstanceMonitorData

get

*Instance.

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
InstanceId	string	Oui	L'identifiant de l'instance à interroger.	i-bp1a36962lrhj4ab****
StartTime	string	Oui	Le début de la plage horaire à interroger. Spécifiez l'heure selon la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ. L'heure doit être en UTC. Si la valeur des secondes (ss) n'est pas 00, l'heure est automatiquement arrondie à la minute supérieure.	2014-10-29T23:00:00Z
EndTime	string	Oui	La fin de la plage horaire à interroger. Spécifiez l'heure selon la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ. L'heure doit être en UTC. Si la valeur des secondes (ss) n'est pas 00, l'heure est automatiquement arrondie à la minute supérieure.	2014-10-30T08:00:00Z
Period	integer	Non	L'intervalle auquel récupérer les données de surveillance. Unité : secondes. Valeurs valides : Valeur par défaut : 60. Valeurs valides : 60 : 60 secondes. 600 : 600 secondes. 3600 : 3600 secondes.	60

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
MonitorData	object
InstanceMonitorData	array<object>	L'ensemble des données de surveillance de l'instance.
	object
CPUCreditBalance	number	Le nombre total de crédits de l'instance burstable.	120
BPSRead	integer	La bande passante de lecture des disques de l'instance (y compris le disque système et les disques de données). Unité : octets/s.	1000
InternetTX	integer	Le trafic de données sortant public envoyé par l'instance pendant l'intervalle spécifié (Period) au moment de la requête (TimeStamp). Unité : kbits.	343
CPU	integer	L'utilisation du vCPU de l'instance. Unité : pourcentage (%).	2
CPUCreditUsage	number	Le nombre de crédits de l'instance burstable consommés.	30
IOPSWrite	integer	Les opérations d'écriture d'E/S sur les disques de l'instance (y compris le disque système et les disques de données). Unité : opérations/s.	200
IntranetTX	integer	Le trafic de données sortant interne envoyé par l'instance pendant l'intervalle spécifié (Period) au moment de la requête (TimeStamp). Unité : kbits.	343
InstanceId	string	L'identifiant de l'instance.	i-bp1a36962lrhj4****
BPSWrite	integer	La bande passante d'écriture des disques de l'instance (y compris le disque système et les disques de données). Unité : octets/s.	13585
CPUNotpaidSurplusCreditUsage	number	Les crédits de CPU à découvert non payés.	0.5
CPUAdvanceCreditBalance	number	Les crédits CPU à découvert (la partie des crédits de l'instance burstable qui dépasse la limite).	0.4
IOPSRead	integer	Les opérations de lecture d'E/S sur les disques de l'instance (y compris le disque système et les disques de données). Unité : opérations/s.	1000
InternetBandwidth	integer	La bande passante publique de l'instance, qui correspond au trafic réseau par unité de temps. Unité : kbits/s.	10
InternetRX	integer	Le trafic de données entrant public reçu par l'instance pendant l'intervalle spécifié (Period) au moment de la requête (TimeStamp). Unité : kbits.	122
TimeStamp	string	L'horodatage des données de surveillance.	2014-10-30T05:00:00Z
IntranetRX	integer	Le trafic de données entrant interne reçu par l'instance pendant l'intervalle spécifié (Period) au moment de la requête (TimeStamp). Unité : kbits.	122
IntranetBandwidth	integer	La bande passante interne de l'instance, qui correspond au trafic réseau par unité de temps. Unité : kbits/s.	10

Exemples

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "MonitorData": {
    "InstanceMonitorData": [
      {
        "CPUCreditBalance": 120,
        "BPSRead": 1000,
        "InternetTX": 343,
        "CPU": 2,
        "CPUCreditUsage": 30,
        "IOPSWrite": 200,
        "IntranetTX": 343,
        "InstanceId": "i-bp1a36962lrhj4****",
        "BPSWrite": 13585,
        "CPUNotpaidSurplusCreditUsage": 0.5,
        "CPUAdvanceCreditBalance": 0.4,
        "IOPSRead": 1000,
        "InternetBandwidth": 10,
        "InternetRX": 122,
        "TimeStamp": "2014-10-30T05:00:00Z",
        "IntranetRX": 122,
        "IntranetBandwidth": 10
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidStartTime.Malformed	The specified parameter "StartTime" is not valid.	Le format de l'heure de début spécifiée n'est pas valide.
400	InvalidEndTime.Malformed	The specified parameter "EndTime" is not valid.	Le format de l'heure de fin spécifié n'est pas valide.
400	InvalidPeriod.ValueNotSupported	The specified parameter "Period" is not valid.
400	InvalidStartTime.TooEarly	The specified parameter "StartTime" is too early.
400	InvalidParameter.TooManyDataQueried	Too many data queried.	Le nœud de données de surveillance est hors limites.
400	Throttling	Request was denied due to request throttling.	La requête est limitée.
400	InvalidStartTime.ValueNotSupported	The specified parameter StartTime is later than EndTime.	L'heure de début spécifiée n'est pas dans la plage autorisée.
500	InternalError	The request processing has failed due to some unknown error.
404	InvalidInstanceId.NotFound	The specified InstanceId does not exist.	L'instance spécifiée n'existe pas. Vérifiez que l'identifiant de l'instance est correct.

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

Notes de version

Consultez Notes de version pour la liste complète.