DescribeMetricData - Cloud Monitor - Centro de documentación de Alibaba Cloud

Descripción de la operación

Límites

La cuota gratuita total es de 1 millón de llamadas al mes para las operaciones DescribeMetricLast, DescribeMetricList, DescribeMetricData y DescribeMetricTop. Si se agota la cuota gratuita y no se ha activado CloudMonitor Basic (pago por uso), estas operaciones de API ya no se podrán llamar como se espera. Si ha activado CloudMonitor Basic (pago por uso), estas operaciones de API se pueden seguir llamando incluso si se agota la cuota gratuita. Si se agota la cuota gratuita, se le cobra automáticamente el exceso de uso según el método de facturación de pago por uso. Para obtener más información sobre cómo activar CloudMonitor Basic (pago por uso), consulte Habilitar el método de facturación de pago por uso.
Cada operación de API se puede llamar hasta 10 veces por segundo. Una cuenta de Alibaba Cloud y los usuarios de Resource Access Management (RAM) dentro de la cuenta comparten la cuota.

Descripción

Nota

A diferencia de DescribeMetricList, la operación DescribeMetricData proporciona funciones estadísticas. Puede configurar el parámetro Dimension como {"instanceId": "i-abcdefgh12****"} para agregar todos los datos de su cuenta de Alibaba Cloud.

Este tema proporciona un ejemplo de cómo consultar los datos de monitoreo de la métrica cpu_idle para Elastic Compute Service (ECS). El espacio de nombres de ECS es acs_ecs_dashboard.

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

cms:QueryMetricData

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Namespace	string	Sí	El espacio de nombres del servicio en la nube. Para obtener más información sobre los espacios de nombres de los servicios en la nube, consulte Apéndice 1: Métricas.	acs_ecs_dashboard
MetricName	string	Sí	La métrica que se utiliza para monitorear el servicio en la nube. Para obtener más información sobre las métricas de los servicios en la nube, consulte Apéndice 1: Métricas.	cpu_idle
Period	string	No	El periodo estadístico de la métrica. Valores válidos: 15, 60, 900 y 3600. Unidad: segundos. Nota Si no se especifica este parámetro, los datos de monitoreo se consultan según el periodo en el que se reportan los valores de la métrica. Para obtener más información sobre el periodo estadístico de una métrica especificada por el parámetro `MetricName`, consulte Apéndice 1: Métricas.	60
StartTime	string	No	El inicio del intervalo de tiempo para consultar los datos de monitoreo. Si no se especifican los parámetros `StartTime` y `EndTime`, se consultan los datos de monitoreo del último periodo estadístico.`` Si se especifican los parámetros `StartTime` y `EndTime`, se consultan los datos de monitoreo del último periodo estadístico en el intervalo de tiempo especificado.```` Los siguientes ejemplos demuestran cómo determinar el periodo en el que se consultan los datos de monitoreo: Si configura el parámetro `Period` en 15, el intervalo de tiempo especificado debe ser menor o igual a 20 minutos. Por ejemplo, si configura el parámetro StartTime en 2021-05-08 08:10:00 y el parámetro EndTime en 2021-05-08 08:30:00, se consultan los datos de monitoreo de los últimos 15 segundos en el intervalo de tiempo. Si configura el parámetro `Period` en 60 o 900, el intervalo de tiempo especificado debe ser menor o igual a 2 horas. Por ejemplo, si configura el parámetro Period en 60, el parámetro StartTime en 2021-05-08 08:00:00 y el parámetro EndTime en 2021-05-08 10:00:00, se consultan los datos de monitoreo de los últimos 60 segundos en el intervalo de tiempo. Si configura el parámetro `Period` en 3600, el intervalo de tiempo especificado debe ser menor o igual a 2 días. Por ejemplo, si configura el parámetro StartTime en 2021-05-08 08:00:00 y el parámetro EndTime en 2021-05-10 08:00:00, se consultan los datos de monitoreo de los últimos 3,600 segundos en el intervalo de tiempo. Se admiten los siguientes formatos: Marca de tiempo UNIX: el número de milisegundos transcurridos desde las 00:00:00 UTC del jueves 1 de enero de 1970. Hora UTC: la hora UTC que sigue el formato AAAA-MM-DDThh:mm:ssZ. Nota Debe configurar el parámetro `StartTime` en un momento posterior a las 00:00:00 UTC del jueves 1 de enero de 1970. De lo contrario, este parámetro no es válido. Se recomienda utilizar marcas de tiempo UNIX para evitar problemas relacionados con la zona horaria.	1618368900000
EndTime	string	No	El final del intervalo de tiempo para consultar los datos de monitoreo. Si no se especifican los parámetros `StartTime` y `EndTime`, se consultan los datos de monitoreo del último periodo estadístico.`` Si se especifican los parámetros `StartTime` y `EndTime`, se consultan los datos de monitoreo del último periodo estadístico en el intervalo de tiempo especificado.```` Los siguientes ejemplos demuestran cómo determinar el periodo en el que se consultan los datos de monitoreo: Si configura el parámetro `Period` en 15, el intervalo de tiempo especificado debe ser menor o igual a 20 minutos. Por ejemplo, si configura el parámetro StartTime en 2021-05-08 08:10:00 y el parámetro EndTime en 2021-05-08 08:30:00, se consultan los datos de monitoreo de los últimos 15 segundos en el intervalo de tiempo. Si configura el parámetro `Period` en 60 o 900, el intervalo de tiempo especificado debe ser menor o igual a 2 horas. Por ejemplo, si configura el parámetro Period en 60, el parámetro StartTime en 2021-05-08 08:00:00 y el parámetro EndTime en 2021-05-08 10:00:00, se consultan los datos de monitoreo de los últimos 60 segundos en el intervalo de tiempo. Si configura el parámetro `Period` en 3600, el intervalo de tiempo especificado debe ser menor o igual a 2 días. Por ejemplo, si configura el parámetro StartTime en 2021-05-08 08:00:00 y el parámetro EndTime en 2021-05-10 08:00:00, se consultan los datos de monitoreo de los últimos 3,600 segundos en el intervalo de tiempo. Se admiten los siguientes formatos: Marca de tiempo UNIX: el número de milisegundos transcurridos desde las 00:00:00 UTC del jueves 1 de enero de 1970. Hora UTC: la hora UTC que sigue el formato AAAA-MM-DDThh:mm:ssZ. Nota Se recomienda utilizar marcas de tiempo UNIX para evitar problemas relacionados con la zona horaria.	1618368960000
Dimensions	string	No	Las dimensiones según las cuales se consultan los recursos. Configure el valor como una colección de pares clave-valor. Un par clave-valor típico es `instanceId:i-2ze2d6j5uhg20x47**`. Nota** Puede consultar un máximo de 50 instancias en una sola solicitud.	[{"instanceId": "i-abcdefgh12****"}]
Express	string	No	La expresión que se utiliza para calcular los resultados de la consulta en tiempo real. Nota Solo se admite la expresión `groupby`. Esta expresión es similar a la instrucción `GROUP BY` que se utiliza en bases de datos.	{"groupby":["userId","instanceId"]}
Length	string	No	El número de entradas por página. Valor predeterminado: 1000. Nota El valor máximo del parámetro Length en una solicitud es 1440.	1000

Para obtener más información sobre los parámetros de solicitud comunes, consulte Parámetros comunes.

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Ninguna.
Code	string	El código de estado HTTP. Nota El código de estado 200 indica que la solicitud fue exitosa.	200
Message	string	El mensaje devuelto.	The specified resource is not found
RequestId	string	El ID de la solicitud.	6A5F022D-AC7C-460E-94AE-B9E75083D027
Datapoints	string	Los datos de monitoreo. El valor incluye los siguientes campos: `timestamp`: la hora en que se activó la alerta. `userId`: el ID del usuario para el cual se activó la alerta. `instanceId`: el ID de la instancia para la cual se activó la alerta. `Minimum`, `Average` y `Maximum`: los métodos de agregación.	[{\"timestamp\":1618368900000,\"Average\":95.8291666666667,\"Minimum\":65.48,\"Maximum\":100.0},{\"timestamp\":1618368960000,\"Average\":95.8683333333333,\"Minimum\":67.84,\"Maximum\":100.0}]
Period	string	El periodo estadístico de los datos de monitoreo. Valores válidos: 15, 60, 900 y 3600. Unidad: segundos.	60

Ejemplos

Respuesta exitosa

JSON Formato

{
  "Code": "200",
  "Message": "The specified resource is not found.",
  "RequestId": "6A5F022D-AC7C-460E-94AE-B9E75083D027",
  "Datapoints": "[{\\\"timestamp\\\":1618368900000,\\\"Average\\\":95.8291666666667,\\\"Minimum\\\":65.48,\\\"Maximum\\\":100.0},{\\\"timestamp\\\":1618368960000,\\\"Average\\\":95.8683333333333,\\\"Minimum\\\":67.84,\\\"Maximum\\\":100.0}]",
  "Period": "60"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
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.

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.