DescribeMetricData - Cloud Monitor: Central de Documentação do Alibaba Cloud

Descrição da operação

Limites

A cota gratuita total é de 1 milhão de chamadas por mês para as operações DescribeMetricLast, DescribeMetricList, DescribeMetricData e DescribeMetricTop. Se a cota gratuita for esgotada e o CloudMonitor Basic (pay-as-you-go) não estiver ativado, essas operações de API não poderão mais ser chamadas conforme esperado. Se você tiver ativado o CloudMonitor Basic (pay-as-you-go), essas operações de API ainda poderão ser chamadas mesmo que a cota gratuita seja esgotada. Se a cota gratuita for esgotada, você será cobrado automaticamente pelo uso excedente com base no método de cobrança pay-as-you-go. Para mais informações sobre como ativar o CloudMonitor Basic (pay-as-you-go), consulte Ativar o método de cobrança pay-as-you-go.
Cada operação de API pode ser chamada até 10 vezes por segundo. Uma conta Alibaba Cloud e os usuários Resource Access Management (RAM) dentro da conta compartilham a cota.

Descrição

Nota

Diferente de DescribeMetricList, a operação DescribeMetricData fornece recursos estatísticos. Você pode definir o parâmetro Dimension como {"instanceId": "i-abcdefgh12****"} para agregar todos os dados da sua conta Alibaba Cloud.

Este tópico fornece um exemplo de como consultar os dados de monitoramento da métrica cpu_idle para o Elastic Compute Service (ECS). O namespace do ECS é acs_ecs_dashboard.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

cms:QueryMetricData

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Namespace	string	Sim	O namespace do serviço em nuvem. Para mais informações sobre os namespaces dos serviços em nuvem, consulte Apêndice 1: Métricas.	acs_ecs_dashboard
MetricName	string	Sim	A métrica usada para monitorar o serviço em nuvem. Para mais informações sobre as métricas dos serviços em nuvem, consulte Apêndice 1: Métricas.	cpu_idle
Period	string	Não	O período estatístico da métrica. Valores válidos: 15, 60, 900 e 3600. Unidade: segundos. Nota Se este parâmetro não for especificado, os dados de monitoramento serão consultados com base no período em que os valores da métrica são reportados. Para mais informações sobre o período estatístico de uma métrica especificada pelo parâmetro `MetricName`, consulte Apêndice 1: Métricas.	60
StartTime	string	Não	O início do intervalo de tempo para consultar dados de monitoramento. Se os parâmetros `StartTime` e `EndTime` não forem especificados, os dados de monitoramento do último período estatístico serão consultados.`` Se os parâmetros `StartTime` e `EndTime` forem especificados, os dados de monitoramento do último período estatístico no intervalo de tempo especificado serão consultados.```` Os exemplos a seguir demonstram como determinar o período em que os dados de monitoramento são consultados: Se você definir o parâmetro `Period` como 15, o intervalo de tempo especificado deve ser menor ou igual a 20 minutos. Por exemplo, se você definir o parâmetro StartTime como 2021-05-08 08:10:00 e o parâmetro EndTime como 2021-05-08 08:30:00, os dados de monitoramento dos últimos 15 segundos no intervalo de tempo serão consultados. Se você definir o `Period` como 60 ou 900, o intervalo de tempo especificado deve ser menor ou igual a 2 horas. Por exemplo, se você definir o parâmetro Period como 60, o parâmetro StartTime como 2021-05-08 08:00:00 e o parâmetro EndTime como 2021-05-08 10:00:00, os dados de monitoramento dos últimos 60 segundos no intervalo de tempo serão consultados. Se você definir o parâmetro `Period` como 3600, o intervalo de tempo especificado deve ser menor ou igual a 2 dias. Por exemplo, se você definir o parâmetro StartTime como 2021-05-08 08:00:00 e o parâmetro EndTime como 2021-05-10 08:00:00, os dados de monitoramento dos últimos 3.600 segundos no intervalo de tempo serão consultados. Os seguintes formatos são suportados: Timestamp UNIX: o número de milissegundos decorridos desde 00:00:00 UTC de quinta-feira, 1 de janeiro de 1970. Hora UTC: a hora UTC que segue o formato YYYY-MM-DDThh:mm:ssZ. Nota Você deve definir o parâmetro `StartTime` como um ponto no tempo posterior a 00:00:00 UTC de quinta-feira, 1 de janeiro de 1970. Caso contrário, este parâmetro será inválido. Recomenda-se usar timestamps UNIX para evitar problemas relacionados a fuso horário.	1618368900000
EndTime	string	Não	O fim do intervalo de tempo para consultar dados de monitoramento. Se os parâmetros `StartTime` e `EndTime` não forem especificados, os dados de monitoramento do último período estatístico serão consultados.`` Se os parâmetros `StartTime` e `EndTime` forem especificados, os dados de monitoramento do último período estatístico no intervalo de tempo especificado serão consultados.```` Os exemplos a seguir demonstram como determinar o período em que os dados de monitoramento são consultados: Se você definir o parâmetro `Period` como 15, o intervalo de tempo especificado deve ser menor ou igual a 20 minutos. Por exemplo, se você definir o parâmetro StartTime como 2021-05-08 08:10:00 e o parâmetro EndTime como 2021-05-08 08:30:00, os dados de monitoramento dos últimos 15 segundos no intervalo de tempo serão consultados. Se você definir o `Period` como 60 ou 900, o intervalo de tempo especificado deve ser menor ou igual a 2 horas. Por exemplo, se você definir o parâmetro Period como 60, o parâmetro StartTime como 2021-05-08 08:00:00 e o parâmetro EndTime como 2021-05-08 10:00:00, os dados de monitoramento dos últimos 60 segundos no intervalo de tempo serão consultados. Se você definir o parâmetro `Period` como 3600, o intervalo de tempo especificado deve ser menor ou igual a 2 dias. Por exemplo, se você definir o parâmetro StartTime como 2021-05-08 08:00:00 e o parâmetro EndTime como 2021-05-10 08:00:00, os dados de monitoramento dos últimos 3.600 segundos no intervalo de tempo serão consultados. Os seguintes formatos são suportados: Timestamp UNIX: o número de milissegundos decorridos desde 00:00:00 UTC de quinta-feira, 1 de janeiro de 1970. Hora UTC: a hora UTC que segue o formato YYYY-MM-DDThh:mm:ssZ. Nota Recomenda-se usar timestamps UNIX para evitar problemas relacionados a fuso horário.	1618368960000
Dimensions	string	Não	As dimensões com base nas quais os recursos são consultados. Defina o valor como uma coleção de pares chave-valor. Um par chave-valor típico é `instanceId:i-2ze2d6j5uhg20x47**`. Nota** Você pode consultar no máximo 50 instâncias em uma única solicitação.	[{"instanceId": "i-abcdefgh12****"}]
Express	string	Não	A expressão usada para computar os resultados da consulta em tempo real. Nota Apenas a expressão `groupby` é suportada. Essa expressão é semelhante à instrução `GROUP BY` usada em bancos de dados.	{"groupby":["userId","instanceId"]}
Length	string	Não	O número de entradas por página. Valor padrão: 1000. Nota O valor máximo do parâmetro Length em uma solicitação é 1440.	1000

Para mais informações sobre parâmetros de solicitação comuns, consulte Parâmetros comuns.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Nenhum.
Code	string	O código de status HTTP. Nota O código de status 200 indica que a solicitação foi bem-sucedida.	200
Message	string	A mensagem retornada.	The specified resource is not found.
RequestId	string	O ID da solicitação.	6A5F022D-AC7C-460E-94AE-B9E75083D027
Datapoints	string	Os dados de monitoramento. O valor inclui os seguintes campos: `timestamp`: a hora em que o alerta foi acionado. `userId`: o ID do usuário para o qual o alerta foi acionado. `instanceId`: o ID da instância para a qual o alerta foi acionado. `Minimum`, `Average` e `Maximum`: os métodos de agregação.	[{\"timestamp\":1618368900000,\"Average\":95.8291666666667,\"Minimum\":65.48,\"Maximum\":100.0},{\"timestamp\":1618368960000,\"Average\":95.8683333333333,\"Minimum\":67.84,\"Maximum\":100.0}]
Period	string	O período estatístico dos dados de monitoramento. Valores válidos: 15, 60, 900 e 3600. Unidade: segundos.	60

Exemplos

Resposta de sucesso

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 erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
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 Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.