DescribeInstanceMonitorData - Elastic Compute Service - Centro de documentación de Alibaba Cloud

Consulta los datos de monitoreo de una instancia de ECS. Las métricas que puede consultar incluyen la utilización de vCPU, los créditos de instancias de ráfaga, el tráfico de datos entrante, el tráfico de datos saliente y el ancho de banda promedio de la instancia de ECS.

Descripción de la operación

Tenga en cuenta los siguientes puntos cuando llame a esta operación:

Se puede devolver un máximo de 400 entradas de datos a la vez. Asegúrese de que el valor de (EndTime – StartTime)/Period sea menor o igual que 400. En otras palabras, el valor del parámetro de respuesta TotalCount no puede exceder 400. De lo contrario, se devuelve el error InvalidParameter.TooManyDataQueried.
Puede consultar los datos de monitoreo de los últimos 30 días. El valor del parámetro StartTime no puede ser anterior en más de 30 días a la fecha actual.
Si falta algún contenido en la respuesta, es posible que el sistema no haya obtenido la información correspondiente. Por ejemplo, la instancia estaba en el estado Stopped en ese momento.
Esta operación no puede recuperar los datos de monitoreo básicos de CPU de las instancias ECS Bare Metal. Puede instalar el agente de CloudMonitor para obtener datos de monitoreo de CPU. Para obtener más información, consulte Instalar el agente de CloudMonitor.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

ecs:DescribeInstanceMonitorData

get

*Instance.

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
InstanceId	string	Sí	El ID de la instancia que se va a consultar.	i-bp1a36962lrhj4ab****
StartTime	string	Sí	El inicio del intervalo de tiempo que se va a consultar. Especifique la hora en el estándar ISO 8601 en el formato yyyy-MM-ddTHH:mm:ssZ. La hora debe estar en UTC. Si el valor de los segundos (`ss`) no es `00`, la hora se redondea automáticamente al minuto siguiente.	2014-10-29T23:00:00Z
EndTime	string	Sí	El final del intervalo de tiempo que se va a consultar. Especifique la hora en el estándar ISO 8601 en el formato yyyy-MM-ddTHH:mm:ssZ. La hora debe estar en UTC. Si el valor de los segundos (`ss`) no es `00`, la hora se redondea automáticamente al minuto siguiente.	2014-10-30T08:00:00Z
Period	integer	No	El intervalo con el que se recuperan los datos de monitoreo. Unidad: segundos. Valores válidos: 60 600 3600 Valor predeterminado: 60. Valores válidos: 60 : 60 segundos. 600 : 600 segundos. 3600 : 3600 segundos.	60

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
MonitorData	object
InstanceMonitorData	array<object>	La colección de datos de monitoreo de la instancia.
	object
CPUCreditBalance	number	El número total de créditos de instancias de ráfaga.	120
BPSRead	integer	El ancho de banda de lectura de los discos de la instancia (incluidos el disco de sistema y los discos de datos). Unidad: bytes/s.	1000
InternetTX	integer	El tráfico de datos saliente público que envía la instancia durante el intervalo especificado (`Period`) en el momento de la consulta (`TimeStamp`). Unidad: kbits.	343
CPU	integer	La utilización de vCPU de la instancia. Unidad: porcentaje (%).	2
CPUCreditUsage	number	El número de créditos de instancias de ráfaga consumidos.	30
IOPSWrite	integer	Las operaciones de escritura de E/S en los discos de la instancia (incluidos el disco de sistema y los discos de datos). Unidad: operaciones/s.	200
IntranetTX	integer	El tráfico de datos saliente interno que envía la instancia durante el intervalo especificado (`Period`) en el momento de la consulta (`TimeStamp`). Unidad: kbits.	343
InstanceId	string	El ID de la instancia.	i-bp1a36962lrhj4****
BPSWrite	integer	El ancho de banda de escritura de los discos de la instancia (incluidos el disco de sistema y los discos de datos). Unidad: bytes/s.	13585
CPUNotpaidSurplusCreditUsage	number	Los créditos de CPU sobregirados no pagados.	0.5
CPUAdvanceCreditBalance	number	Los créditos de CPU anticipados (la parte de los créditos de instancias de ráfaga que excede el límite).	0.4
IOPSRead	integer	Las operaciones de lectura de E/S en los discos de la instancia (incluidos el disco de sistema y los discos de datos). Unidad: operaciones/s.	1000
InternetBandwidth	integer	El ancho de banda público de la instancia, que es el tráfico de red por unidad de tiempo. Unidad: kbits/s.	10
InternetRX	integer	El tráfico de datos entrante público que recibe la instancia durante el intervalo especificado (`Period`) en el momento de la consulta (`TimeStamp`). Unidad: kbits.	122
TimeStamp	string	La marca de tiempo de los datos de monitoreo.	2014-10-30T05:00:00Z
IntranetRX	integer	El tráfico de datos entrante interno que recibe la instancia durante el intervalo especificado (`Period`) en el momento de la consulta (`TimeStamp`). Unidad: kbits.	122
IntranetBandwidth	integer	El ancho de banda interno de la instancia, que es el tráfico de red por unidad de tiempo. Unidad: kbits/s.	10

Ejemplos

Respuesta exitosa

JSON Formato

{
  "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
      }
    ]
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	InvalidStartTime.Malformed	The specified parameter "StartTime" is not valid.	El formato de la hora de inicio especificada no es válido.
400	InvalidEndTime.Malformed	The specified parameter "EndTime" is not valid.	El formato de la hora de finalización especificado no es válido.
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.	El nodo de datos de monitoreo está fuera de rango.
400	Throttling	Request was denied due to request throttling.	La solicitud se ha limitado.
400	InvalidStartTime.ValueNotSupported	The specified parameter StartTime is later than EndTime.	La hora de inicio especificada no se encuentra dentro del rango permitido.
500	InternalError	The request processing has failed due to some unknown error.
404	InvalidInstanceId.NotFound	The specified InstanceId does not exist.	La instancia especificada no existe. Verifique si el ID de la instancia es correcto.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.