DescribeMetricTop - : 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 ordenados por uma ordem especificada.

Limites

Cada operação de API pode ser chamada até 10 vezes por segundo. A conta da Alibaba Cloud e os usuários RAM vinculados a ela compartilham essa 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). Quanto maior o valor do parâmetro Period, mais distribuídos ficam os dados de monitoramento no tempo e maior é a duração de armazenamento. As relações específicas estão descritas a seguir:

Se o valor do parâmetro Period for inferior a 60 segundos, a duração de armazenamento é de sete dias.
Se o valor do parâmetro Period for igual a 60 segundos, a duração de armazenamento é de 31 dias.
Se o valor do parâmetro Period for igual a 300 segundos, a duração de armazenamento é de 91 dias.

Observações de uso

Este tópico apresenta 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 ordenados em ordem decrescente com base no campo Average.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para facilitar o uso, recomendamos chamar esta operação no OpenAPI Explorer, que gera dinamicamente o código de exemplo para diferentes SDKs.

Parâmetros de requisição

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeMetricTop	A operação a ser executada. Defina o valor como DescribeMetricTop.
Period	String	No	60	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 reportados. Os períodos estatísticos variam de acordo com as métricas especificadas por `MetricName`. Para obter mais informações, consulte Appendix 1: Metrics.
Namespace	String	Yes	acs_ecs_dashboard	O namespace do serviço de nuvem. Para obter mais informações sobre os namespaces dos serviços de nuvem, consulte Appendix 1: Metrics.
MetricName	String	Yes	cpu_idle	A métrica utilizada para monitorar o serviço de nuvem. Para obter mais informações sobre os nomes de métricas, consulte Appendix 1: Metrics.
StartTime	String	No	2021-05-08 08:00:00	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 dentro do intervalo especificado serão consultados. Os exemplos a seguir demonstram como determinar o período em que os dados de monitoramento são consultados: Se o parâmetro `Period` for definido como 15, o intervalo de tempo especificado deve ser menor ou igual a 20 minutos. Por exemplo, ao definir StartTime como 2021-05-08 08:10:00 e EndTime como 2021-05-08 08:30:00, os dados de monitoramento dos últimos 15 segundos dentro do intervalo serão consultados. Se o parâmetro `Period` for definido como 60 ou 900, o intervalo de tempo especificado deve ser menor ou igual a 2 horas. Por exemplo, ao definir Period como 60, StartTime como 2021-05-08 08:00:00 e EndTime como 2021-05-08 10:00:00, os dados de monitoramento dos últimos 60 segundos dentro do intervalo serão consultados. Se o parâmetro `Period` for definido como 3600, o intervalo de tempo especificado deve ser menor ou igual a dois dias. Por exemplo, ao definir StartTime como 2021-05-08 08:00:00 e EndTime como 2021-05-10 08:00:00, os dados de monitoramento dos últimos 3.600 segundos dentro do intervalo serão consultados. Os seguintes formatos são aceitos: Timestamp UNIX: número de milissegundos decorridos desde 00:00:00 de quinta-feira, 1º de janeiro de 1970. Formato de hora: YYYY-MM-DDThh:mm:ssZ Nota O parâmetro `StartTime` deve ser definido como um momento posterior a 00:00:00 de quinta-feira, 1º de janeiro de 1970. Caso contrário, este parâmetro será inválido. Recomendamos usar timestamps UNIX para evitar problemas relacionados a fusos horários.
EndTime	String	No	2021-05-08 10:00:00	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 dentro do intervalo especificado serão consultados. Os exemplos a seguir demonstram como determinar o período em que os dados de monitoramento são consultados: Se o parâmetro `Period` for definido como 15, o intervalo de tempo especificado deve ser menor ou igual a 20 minutos. Por exemplo, ao definir StartTime como 2021-05-08 08:10:00 e EndTime como 2021-05-08 08:30:00, os dados de monitoramento dos últimos 15 segundos dentro do intervalo serão consultados. Se o parâmetro `Period` for definido como 60 ou 900, o intervalo de tempo especificado deve ser menor ou igual a 2 horas. Por exemplo, ao definir Period como 60, StartTime como 2021-05-08 08:00:00 e EndTime como 2021-05-08 10:00:00, os dados de monitoramento dos últimos 60 segundos dentro do intervalo serão consultados. Se o parâmetro `Period` for definido como 3600, o intervalo de tempo especificado deve ser menor ou igual a dois dias. Por exemplo, ao definir StartTime como 2021-05-08 08:00:00 e EndTime como 2021-05-10 08:00:00, os dados de monitoramento dos últimos 3.600 segundos dentro do intervalo serão consultados. Os seguintes formatos são aceitos: Timestamp UNIX: número de milissegundos decorridos desde 00:00:00 de quinta-feira, 1º de janeiro de 1970. Formato de hora: YYYY-MM-DDThh:mm:ssZ Nota Recomendamos usar timestamps UNIX para evitar problemas relacionados a fusos horários.
Dimensions	String	No	[{"instanceId": "i-2ze2d6j5uhg20x47****"}]	As dimensões de monitoramento do recurso especificado. Defina o valor como uma coleção de pares `key:value`. Exemplo: `{"userId":"120886317861"}` ou `{"instanceId":"i-2ze2d6j5uhg20x47"}`. Nota É possível consultar no máximo 50 instâncias em uma única requisição.
Orderby	String	Yes	Average	O campo pelo qual os dados são ordenados. Valores válidos: Average: o valor médio. Minimum: o valor mínimo. Maximum: o valor máximo.
OrderDesc	String	No	False	A ordem de classificação dos dados. Valores válidos: True: classifica os dados em ordem crescente. False (padrão): classifica os dados em ordem decrescente.
Length	String	No	10	O número de entradas por página. Valor padrão: 10. Nota O valor máximo do parâmetro Length em uma requisição é 1440.
Express	String	No	{"groupby":["userId","instanceId"]}	A expressão utilizada para calcular os resultados da consulta em tempo real. Nota Apenas a expressão `groupby` é compatível. Essa expressão é semelhante à instrução GROUP BY utilizada em bancos de dados.

Para obter mais informações sobre os parâmetros de requisição comuns, consulte Common parameters.

Parâmetros de resposta

Parameter	Type	Example	Description
Code	String	200	O código de status. Nota O código de status 200 indica que a requisição foi bem-sucedida.
Message	String	The specified resource is not found.	A mensagem de erro.
RequestId	String	3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42	O ID da requisição.
Datapoints	String	[{\"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}]	Os dados de monitoramento.
Period	String	60	O período estatístico dos dados de monitoramento. Unidade: segundos. Valores válidos: 15, 60, 900 e 3600.

Exemplos

Exemplos de requisições

http(s)://[Endpoint]/?Action=DescribeMetricTop
&MetricName=cpu_idle
&Namespace=acs_ecs_dashboard
&Period=60
&Orderby=Average
&OrderDesc=False
&<Common request parameters>

Exemplos de respostas bem-sucedidas

XML formato

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

<DescribeMetricTopResponse>
    <RequestId>18DC44ED-B058-49B0-9D49-1D6608328E4D</RequestId>
    <Period>60</Period>
    <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}]</Datapoints>
    <Code>200</Code>
</DescribeMetricTopResponse>

JSON formato

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

{
  "RequestId" : "18DC44ED-B058-49B0-9D49-1D6608328E4D",
  "Period" : "60",
  "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}]",
  "Code" : "200"
}

Códigos de erro

HTTP status code	Error code	Error message	Description
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.

Para obter a lista de códigos de erro, consulte Service error codes.