Todos os produtos
Search
Central de documentação

:DescribeMetricList

Última atualização: Jul 05, 2026

Consulta os dados de monitoramento de uma métrica de um serviço de nuvem especificado.

Limites

O limite de chamadas para cada operação de API é de 50 vezes por segundo. A conta Alibaba Cloud e os usuários RAM vinculados a ela compartilham essa cota.

Precauções

A retenção dos dados de monitoramento de cada serviço de nuvem depende do parâmetro Period (período estatístico). Quanto maior o valor de Period, maior o intervalo de tempo abrangido pelos dados consultados e maior a duração do armazenamento. A lista a seguir detalha essas relações:

  • Valores de Period inferiores a 60 segundos resultam em retenção de sete dias.

  • Valor de Period igual a 60 segundos resulta em retenção de 31 dias.

  • Valor de Period igual a 300 segundos resulta em retenção de 91 dias.

Notas de uso

Este tópico apresenta um exemplo de consulta dos dados de monitoramento da métrica cpu_idle do Elastic Compute Service (ECS), cujo namespace é acs_ecs_dashboard. O resultado indica que os dados da instância i-abcdefgh12****, pertencente à conta 120886317861****, foram consultados com intervalo de 60 segundos. Os valores máximo, mínimo e médio da métrica são, respectivamente, 100, 93.1 e 99.52.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos usar esta ferramenta para chamar a operação, pois ela gera dinamicamente códigos de exemplo para diferentes SDKs.

Parâmetros de solicitação

Parâmetro Tipo Obrigatório Exemplo Descrição
Action String Sim DescribeMetricList

Operação a ser executada. Defina o valor como DescribeMetricList.

Namespace String Sim acs_ecs_dashboard

Namespace do serviço de nuvem.

Para mais informações sobre namespaces de serviços de nuvem, consulte Apêndice 1: Métricas.

MetricName String Sim cpu_idle

Métrica usada para monitorar o serviço de nuvem.

Para mais informações sobre nomes de métricas, consulte Apêndice 1: Métricas.

Period String Não 60

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, a consulta usará o período padrão de relatório dos valores da métrica.
  • Os períodos estatísticos variam conforme as métricas definidas em MetricName. Para mais detalhes, consulte Apêndice 1: Métricas.
StartTime String Não 2019-01-30 00:00:00

Início do intervalo de tempo da consulta. Formatos aceitos:

  • Timestamp UNIX: milissegundos decorridos desde 00:00:00 de quinta-feira, 1º de janeiro de 1970.
  • Formato de hora: AAAA-MM-DDThh:mm:ssZ.
Nota
  • O intervalo inclui a hora final, mas exclui a inicial. A hora inicial deve ser anterior à final.
  • A diferença entre a hora inicial e a final não pode exceder 31 dias.
EndTime String Não 2019-01-30 00:10:00

Fim do intervalo de tempo da consulta. Formatos aceitos:

  • Timestamp UNIX: milissegundos decorridos desde 00:00:00 de quinta-feira, 1º de janeiro de 1970.
  • Formato de hora: AAAA-MM-DDThh:mm:ssZ.
Nota A diferença entre a hora inicial e a final não pode exceder 31 dias.
Dimensions String Não [{"instanceId":"i-2ze2d6j5uhg20x47****"}]

Dimensões de monitoramento do recurso especificado.

Defina o valor como um conjunto de pares chave:valor. Exemplo: {"userId":"120886317861**"} ou {"instanceId":"i-2ze2d6j5uhg20x47**"}.

Nota É possível consultar até 50 instâncias por solicitação.
NextToken String Não 15761485350009dd70bb64cff1f0fff750b08ffff073be5fb1e785e2b020f1a949d5ea14aea7fed82f01dd8****

Token de paginação.

Nota Se omitido, o sistema retorna a primeira página. Um valor diferente de Null indica que há mais entradas disponíveis; use-o como parâmetro de entrada para obter a próxima página. O valor Null sinaliza que todos os resultados já foram retornados.
Length String Não 1000

Número de entradas por página.

Nota O valor máximo permitido para Length em uma solicitação é 1440.
Express String Não {"groupby":["userId","instanceId"]}

Expressão para cálculo dos resultados da consulta em tempo real.

Nota Somente a expressão groupby é aceita. Ela funciona de modo semelhante à cláusula GROUP BY de bancos de dados.

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

Parâmetros de resposta

Parâmetro Tipo Exemplo Descrição
NextToken String 15761441850009dd70bb64cff1f0fff6d0b08ffff073be5fb1e785e2b020f7fed9b5e137bd810a6d6cff5ae****

Token de paginação.

RequestId String 3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42

ID da solicitação.

Success Boolean true

Indica se a solicitação foi bem-sucedida. Valores válidos:

  • true
  • false
Datapoints String [{"timestamp":1548777660000,"userId":"120886317861****","instanceId":"i-abc","Minimum":9.92,"Average":9.92,"Maximum":9.92}]

Dados de monitoramento.

Code String 200

Código de status.

Nota O código 200 indica sucesso na solicitação.
Message String The specified resource is not found.

Mensagem de erro.

Period String 60

Intervalo de tempo. Unidade: segundos. Valores válidos: 60, 300 e 900.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=DescribeMetricList
&MetricName=cpu_idle
&Namespace=acs_ecs_dashboard
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeMetricListResponse>
	<Period>60</Period>
	<Datapoints>
		<timestamp>1490152860000</timestamp>
		<Maximum>100</Maximum>
		<userId>120886317861****</userId>
		<Minimum>93.1</Minimum>
		<instanceId>i-abcdefgh12****</instanceId>
		<Average>99.52</Average>
	</Datapoints>
	<RequestId>6A5F022D-AC7C-460E-94AE-B9E75083D027</RequestId>
	<Success>true</Success>
	<Code>200</Code>
</DescribeMetricListResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Period" : "60",
  "Datapoints" : [ {
    "timestamp" : 1490152860000,
    "Maximum" : 100,
    "userId" : "120886317861****",
    "Minimum" : 93.1,
    "instanceId" : "i-abcdefgh12****",
    "Average" : 99.52
  } ],
  "RequestId" : "6A5F022D-AC7C-460E-94AE-B9E75083D027",
  "Success" : true,
  "Code" : "200"
}

Códigos de erro

Código de status HTTP

Código de erro

Mensagem de erro

Descrição

404

ResourceNotFound

The specified resource is not found.

O recurso especificado não foi encontrado.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.