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

Descrição da operação

Limites

Você tem uma cota gratuita de 1 milhão de chamadas de API totais por mês para as operações DescribeMetricLast, DescribeMetricList, DescribeMetricData e DescribeMetricTop. Se você esgotar a cota gratuita e não tiver ativado o método de cobrança pay-as-you-go para o CloudMonitor Basic, não poderá mais usar essas operações de API. Se você tiver ativado o método de cobrança pay-as-you-go, poderá continuar a usar as operações de API após a cota gratuita ser esgotada. As chamadas de API que excederem a cota gratuita serão cobradas automaticamente com base no método pay-as-you-go. Para obter mais informações, consulte Ativar pay-as-you-go.
Você pode chamar cada operação de API até 50 vezes por segundo. Esse limite é compartilhado entre uma conta Alibaba Cloud e seus usuários RAM.

Nota

Se você receber a mensagem de erro Throttling.User ou Request was denied due to user flow control ao chamar uma operação de API, a chamada de API será limitada. Para obter mais informações, consulte Como resolvo um problema de limitação de chamada de API?.

Observações

A duração do armazenamento dos dados de monitoramento de um serviço em nuvem depende do Period (período estatístico). Um valor maior de Period indica que os dados de monitoramento são menos granulares e são armazenados por um período mais longo. A relação é a seguinte:

Se o valor de Period for menor que 60 segundos, a duração do armazenamento será de 7 dias.
Se o valor de Period for de 60 segundos, a duração do armazenamento será de 31 dias.
Se o valor de Period for de 300 segundos ou maior, a duração do armazenamento será de 91 dias.

Notas de uso

Este tópico fornece um exemplo de como consultar os dados de monitoramento da métrica cpu_idle para o serviço em nuvem acs_ecs_dashboard. A resposta mostra os dados da instância i-abcdefgh12****, que pertence à conta Alibaba Cloud 120886317861****. Em um intervalo de 60 segundos, os valores máximo, mínimo e médio da métrica são 100, 93,1 e 99,52, respectivamente.

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

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 obter mais informações, consulte Métricas.	acs_ecs_dashboard
MetricName	string	Sim	O nome da métrica. Para obter mais informações, consulte Métricas.	cpu_idle
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 você não definir este parâmetro, o período de relatório especificado quando a métrica foi registrada será usado. O período estatístico de cada métrica (MetricName) de um serviço em nuvem é diferente. Para obter mais informações, consulte Métricas.	60
StartTime	string	Não	O início do intervalo de tempo a ser consultado. Os seguintes formatos são suportados: Timestamp UNIX: o número de milissegundos decorridos desde 00:00:00 UTC em 1º de janeiro de 1970. Formato: AAAA-MM-DD hh:mm:ss. Nota O intervalo de tempo é um intervalo aberto à esquerda e fechado à direita. O valor de StartTime deve ser anterior ao valor de EndTime. O intervalo entre StartTime e EndTime deve ser menor ou igual a 31 dias.	2019-01-30 00:00:00
EndTime	string	Não	O fim do intervalo de tempo a ser consultado. Os seguintes formatos são suportados: Timestamp UNIX: o número de milissegundos decorridos desde 00:00:00 UTC em 1º de janeiro de 1970. Formato: AAAA-MM-DD hh:mm:ss. Nota O intervalo entre StartTime e EndTime deve ser menor ou igual a 31 dias.	2019-01-30 00:10:00
Dimensions	string	Não	As dimensões que especificam os recursos a serem monitorados. Formato: uma coleção de pares chave-valor, como {"userId":"120886317861**"} e {"instanceId":"i-2ze2d6j5uhg20x47"}. Nota** Uma única solicitação pode ser usada para consultar no máximo 50 instâncias.	[{"instanceId":"i-2ze2d6j5uhg20x47****"}]
NextToken	string	Não	O cursor de paginação. Nota Se você não definir este parâmetro, a primeira página de dados será retornada. Se um valor for retornado para este parâmetro, isso indica que há mais dados disponíveis. Para recuperar a próxima página, use o valor retornado como o NextToken na sua próxima solicitação. Um valor nulo indica que todos os dados foram recuperados.	15761485350009dd70bb64cff1f0fff750b08ffff073be5fb1e785e2b020f1a949d5ea14aea7fed82f01dd8****
Length	string	Não	O número de entradas a serem retornadas em cada página para uma consulta paginada. Nota O valor máximo de Length em uma única solicitação é 1440.	1000
Express	string	Não	A expressão usada para computação em tempo real com base nos resultados da consulta. Nota Apenas a expressão groupby é suportada. Essa expressão é semelhante à instrução GROUP BY em bancos de dados.	{"groupby":["userId","instanceId"]}

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

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
NextToken	string	O cursor de paginação.	15761441850009dd70bb64cff1f0fff6d0b08ffff073be5fb1e785e2b020f7fed9b5e137bd810a6d6cff5ae****
RequestId	string	O ID da solicitação.	3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42
Success	boolean	Indica se a operação foi bem-sucedida. Valores válidos: true: A operação foi bem-sucedida. false: A operação falhou.	true
Datapoints	string	A lista de dados de monitoramento.	[{"timestamp":1548777660000,"userId":"120886317861****","instanceId":"i-abc","Minimum":9.92,"Average":9.92,"Maximum":9.92}]
Code	string	O código de status. Nota Um valor 200 indica que a chamada foi bem-sucedida.	200
Message	string	A mensagem de erro.	The specified resource is not found.
Period	string	O período estatístico. Unidade: segundos. Valores válidos: 60, 300 e 900.	60

Exemplos

Resposta de sucesso

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 erro

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

Notas de versão

Consulte Notas de Versão para uma lista completa.