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

Descripción de la operación

Límites

Usted cuenta con una cuota gratuita de 1 millón de llamadas a API en total por mes para las operaciones DescribeMetricLast, DescribeMetricList, DescribeMetricData y DescribeMetricTop. Si agota la cuota gratuita y no ha habilitado el método de facturación de pago por uso para CloudMonitor Basic, ya no podrá utilizar estas operaciones de API. Si ha habilitado el método de facturación de pago por uso, podrá continuar utilizando las operaciones de API después de agotar la cuota gratuita. Las llamadas a API que excedan la cuota gratuita se cobran automáticamente bajo el esquema de pago por uso. Para obtener más información, consulte Habilitar pago por uso.
Puede llamar a cada operación de API hasta 50 veces por segundo. Este límite se comparte entre una cuenta de Alibaba Cloud y sus usuarios RAM.

Nota

Si recibe el mensaje de error Throttling.User o Request was denied due to user flow control al llamar a una operación de API, significa que la llamada está siendo limitada. Para obtener más información, consulte ¿Cómo resuelvo un problema de limitación de llamadas a API?.

Notas

La duración de almacenamiento de los datos de monitoreo para un servicio en la nube depende del parámetro Period (periodo estadístico). Un valor mayor de Period indica que los datos de monitoreo tienen menor granularidad y se almacenan durante un periodo más largo. La relación es la siguiente:

Si el valor de Period es menor a 60 segundos, la duración de almacenamiento es de 7 días.
Si el valor de Period es de 60 segundos, la duración de almacenamiento es de 31 días.
Si el valor de Period es de 300 segundos o superior, la duración de almacenamiento es de 91 días.

Notas de uso

Este tema proporciona un ejemplo de cómo consultar los datos de monitoreo de la métrica cpu_idle para el servicio en la nube acs_ecs_dashboard. La respuesta muestra los datos de la instancia i-abcdefgh12****, que pertenece a la cuenta de Alibaba Cloud 120886317861****. Con un intervalo de 60 segundos, los valores máximo, mínimo y promedio de la métrica son 100, 93.1 y 99.52, respectivamente.

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

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, consulte Métricas.	acs_ecs_dashboard
MetricName	string	Sí	El nombre de la métrica. Para obtener más información, consulte Métricas.	cpu_idle
Period	string	No	El periodo estadístico de los datos de monitoreo. Valores válidos: 15, 60, 900 y 3600. Unidad: segundos. Nota Si no establece este parámetro, se utiliza el periodo de reporte que se especificó cuando se registró la métrica. El periodo estadístico de cada métrica (`MetricName`) de un servicio en la nube es diferente. Para obtener más información, consulte Métricas.	60
StartTime	string	No	El inicio del rango de tiempo a consultar. Se admiten los siguientes formatos: Marca de tiempo UNIX: el número de milisegundos transcurridos desde las 00:00:00 UTC del 1 de enero de 1970. Formato: AAAA-MM-DD hh:mm:ss. Nota El rango de tiempo es un intervalo abierto por la izquierda y cerrado por la derecha. El valor de `StartTime` debe ser anterior al valor de `EndTime`. El intervalo entre `StartTime` y `EndTime` debe ser menor o igual a 31 días.	2019-01-30 00:00:00
EndTime	string	No	El fin del rango de tiempo a consultar. Se admiten los siguientes formatos: Marca de tiempo UNIX: el número de milisegundos transcurridos desde las 00:00:00 UTC del 1 de enero de 1970. Formato: AAAA-MM-DD hh:mm:ss. Nota El intervalo entre `StartTime` y `EndTime` debe ser menor o igual a 31 días.	2019-01-30 00:10:00
Dimensions	string	No	Las dimensiones que especifican los recursos que se van a monitorear. Formato: una colección de pares clave-valor, como `{"userId":"120886317861**"}` y `{"instanceId":"i-2ze2d6j5uhg20x47"}`. Nota** Una sola solicitud permite consultar un máximo de 50 instancias.	[{"instanceId":"i-2ze2d6j5uhg20x47****"}]
NextToken	string	No	El cursor de paginación. Nota Si no establece este parámetro, se devuelve la primera página de datos. Si se devuelve un valor para este parámetro, indica que hay más datos disponibles. Para recuperar la página siguiente, utilice el valor devuelto como `NextToken` en su próxima solicitud. Un valor nulo indica que se han recuperado todos los datos.	15761485350009dd70bb64cff1f0fff750b08ffff073be5fb1e785e2b020f1a949d5ea14aea7fed82f01dd8****
Length	string	No	El número de entradas a devolver en cada página para una consulta paginada. Nota El valor máximo de `Length` en una sola solicitud es 1440.	1000
Express	string	No	La expresión que se utiliza para el cálculo en tiempo real basado en los resultados de la consulta. Nota Solo se admite la expresión groupby. Esta expresión es similar a la instrucción GROUP BY en bases de datos.	{"groupby":["userId","instanceId"]}

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
NextToken	string	El cursor de paginación.	15761441850009dd70bb64cff1f0fff6d0b08ffff073be5fb1e785e2b020f7fed9b5e137bd810a6d6cff5ae****
RequestId	string	El ID de la solicitud.	3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42
Success	boolean	Indica si la operación se realizó correctamente. Valores válidos: true: La operación se realizó correctamente. false: La operación falló.	true
Datapoints	string	La lista de datos de monitoreo.	[{"timestamp":1548777660000,"userId":"120886317861****","instanceId":"i-abc","Minimum":9.92,"Average":9.92,"Maximum":9.92}]
Code	string	El código de estado. Nota Un valor de 200 indica que la llamada se realizó correctamente.	200
Message	string	El mensaje de error.	The specified resource is not found
Period	string	El periodo estadístico. Unidad: segundos. Valores válidos: 60, 300 y 900.	60

Ejemplos

Respuesta exitosa

JSON Formato

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

Códigos de error

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

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.