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

Consulta os dados de monitoramento mais recentes de uma métrica para um serviço de nuvem. Os dados podem ser classificados em uma ordem especificada.

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 (pago conforme o uso) não estiver ativado, essas operações de API não poderão mais ser chamadas conforme o esperado. Se você ativou o CloudMonitor Basic (pago conforme o uso), essas operações de API ainda poderão ser chamadas mesmo que a cota gratuita seja esgotada. Após o esgotamento da cota gratuita, você será cobrado pelo uso excedente com base no método de faturamento pago conforme o uso. Para obter mais informações sobre como ativar o CloudMonitor Basic (pago conforme o uso), consulte Ativar o método de faturamento pago conforme o uso.
Cada operação de API pode ser chamada até 10 vezes por segundo. Uma conta Alibaba Cloud e os usuários do Resource Access Management (RAM) dentro da conta compartilham a cota.

Precauções

A duração de armazenamento dos dados de monitoramento de cada serviço de nuvem está relacionada ao parâmetro Period (período estatístico). Um valor maior do parâmetro Period indica que os dados de monitoramento são distribuídos em um intervalo de tempo maior e a duração de armazenamento dos dados de monitoramento é mais longa. A lista a seguir descreve as relações específicas:

A duração de armazenamento é de 7 dias se o valor do parâmetro Period for menor que 60 segundos.
A duração de armazenamento é de 31 dias se o valor do parâmetro Period for 60 segundos.
A duração de armazenamento é de 91 dias se o valor do Period for maior ou igual a 300 segundos.

Descrição da operação

Este tópico fornece um exemplo de como consultar os dados de monitoramento da métrica cpu_idle nos últimos 60 segundos para o Elastic Compute Service (ECS). O namespace do ECS é acs_ecs_dashboard. Os dados de monitoramento são classificados em ordem decrescente com base no campo Average.

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

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Period	string	Não	O período estatístico dos dados de monitoramento. 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 relatados. Os períodos estatísticos variam de acordo com as métricas especificadas por `MetricName`. Para obter mais informações, consulte Apêndice 1: Métricas.	60
Namespace	string	Sim	O namespace do serviço de nuvem. Para obter mais informações sobre os namespaces dos serviços de nuvem, consulte Apêndice 1: Métricas.	acs_ecs_dashboard
MetricName	string	Sim	A métrica usada para monitorar o serviço de nuvem. Para obter mais informações sobre os nomes das métricas, consulte Apêndice 1: Métricas.	cpu_idle
StartTime	string	Não	O início do intervalo de tempo para consultar os 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.```` 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 parâmetro `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 dois 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 de quinta-feira, 1 de janeiro de 1970 Formato de hora: AAAA-MM-DDThh:mm:ssZ Nota Você deve definir o parâmetro `StartTime` para um ponto no tempo que seja posterior a 00:00:00 de quinta-feira, 1 de janeiro de 1970. Caso contrário, este parâmetro é inválido. Recomendamos o uso de timestamps UNIX para evitar problemas relacionados ao fuso horário.	2021-05-08 08:00:00
EndTime	string	Não	O fim do intervalo de tempo para consultar os 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.```` 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 parâmetro `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 dois 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 de quinta-feira, 1 de janeiro de 1970 Formato de hora: AAAA-MM-DDThh:mm:ssZ Nota Recomendamos o uso de timestamps UNIX para evitar problemas relacionados ao fuso horário.	2021-05-08 10:00:00
Dimensions	string	Não	As dimensões de monitoramento do recurso especificado. Defina o valor como uma coleção de pares `chave:valor`. Exemplo: `{"userId":"120886317861**"}` ou `{"instanceId":"i-2ze2d6j5uhg20x47"}`. Nota** Você pode consultar no máximo 50 instâncias em cada solicitação.	[{"instanceId": "i-2ze2d6j5uhg20x47****"}]
Orderby	string	Sim	O campo com base no qual os dados são classificados. Valores válidos: Average Minimum Maximum	Average
OrderDesc	string	Não	A ordem na qual os dados são classificados. Valores válidos: True: classifica os dados em ordem crescente. False (padrão): classifica os dados em ordem decrescente.	false
Length	string	Não	O número de entradas por página. Valor padrão: 10. Nota O valor máximo do parâmetro Length em uma solicitação é 1440.	10
Express	string	Não	A expressão usada para calcular os resultados da consulta em tempo real. Nota Apenas a expressão `groupby` é suportada. Esta expressão é semelhante à instrução GROUP BY usada em bancos de dados.	{"groupby":["userId","instanceId"]}

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

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
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 de erro.	The specified resource is not found.
RequestId	string	O ID da solicitação.	3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42
Datapoints	string	Os dados de monitoramento.	[{\"order\":1,\"timestamp\":1620287520000,\"userId\":\"120886317861**\",\"instanceId\":\"i-j6ccf7d5fn335qpo\",\"Average\":99.92,\"Minimum\":99.5,\"Maximum\":100.0,\"_count\":1.0},{\"order\":2,\"timestamp\":1620287520000,\"userId\":\"120886317861\",\"instanceId\":\"i-0xii2bvf42iqvxbp**\",\"Average\":99.91,\"Minimum\":99.0,\"Maximum\":100.0,\"_count\":1.0}]
Period	string	O período estatístico dos dados de monitoramento. Unidade: segundos. Valores válidos: 15, 60, 900 e 3600.	60

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "200",
  "Message": "The specified resource is not found.",
  "RequestId": "3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42",
  "Datapoints": "[{\\\"order\\\":1,\\\"timestamp\\\":1620287520000,\\\"userId\\\":\\\"120886317861****\\\",\\\"instanceId\\\":\\\"i-j6ccf7d5fn335qpo****\\\",\\\"Average\\\":99.92,\\\"Minimum\\\":99.5,\\\"Maximum\\\":100.0,\\\"_count\\\":1.0},{\\\"order\\\":2,\\\"timestamp\\\":1620287520000,\\\"userId\\\":\\\"120886317861****\\\",\\\"instanceId\\\":\\\"i-0xii2bvf42iqvxbp****\\\",\\\"Average\\\":99.91,\\\"Minimum\\\":99.0,\\\"Maximum\\\":100.0,\\\"_count\\\":1.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.