View a markdown version of this page

GetSeries - Amazon CloudWatch

GetSeries

A operação GetSeries retorna a lista de séries temporais cujos rótulos correspondem a um ou mais seletores.

Verbos HTTP válidos:

GET, POST

URI válido

/api/v1/series

O URL completo da solicitação combina o host de monitoramento do CloudWatch para a região da AWS com o caminho da operação, por exemplo https://monitoring.AWS Region.amazonaws.com/api/v1/series. Para obter mais informações sobre endpoints, assinaturas e as permissões necessárias do IAM, consulte Consultas do PromQL.

Parâmetros da consulta de URL

Os parâmetros a seguir são transmitidos na string de consulta de URL para solicitações GET ou como campos de corpo codificados em formulário para solicitações POST.

Parâmetro Descrição

match[]

Obrigatório. Seletor de séries que filtra as séries temporais a serem retornadas. Cada seletor deve incluir uma correspondência exata (=) no nome da métrica — por exemplo, {"http.server.active_requests"} ou {__name__="http.server.active_requests"}. Seletores sem uma correspondência igual ao nome da métrica não são suportados. Além da correspondência exata, os combinadores de rótulos também são compatíveis com correspondência não igual (!=), correspondência regex (=~) e correspondência regex negativa (!~). Especifique match[] uma ou mais vezes para combinar seletores. Para mais informações sobre sintaxe de seletores, consulte Consultas do PromQL.

start

Obrigatório. Início do intervalo de tempo a ser considerado, como um carimbo de data e hora RFC 3339 ou Unix.

end

Obrigatório. Fim do intervalo de tempo a ser considerado, como um carimbo de data e hora RFC 3339 ou Unix.

limit

Opcional. Número máximo de séries temporais exclusivas a serem retornadas, de 1 a 10000. Caso você não especifique limit, o CloudWatch retornará até o máximo (10.000). Consulte Limite de resultados.

Permissões obrigatórias do IAM

Para chamar GetSeries, a identidade da chamada deve ter a seguinte ação do IAM:

  • cloudwatch:ListMetrics

Para obter o mapeamento completo das ações do IAM para todas as operações do PromQL, consulte Permissões do IAM para o PromQL.

Limite de resultados

Uma única resposta /api/v1/series pode retornar até 10.000 séries temporais exclusivas. Para solicitar menos resultados, passe o parâmetro limit com um valor de 1 para 10000. Caso você não especifique limit, o CloudWatch retornará até o máximo.

Quando as séries correspondentes excedem o limite, a resposta é truncada e uma mensagem é incluída no campo warnings padrão do Prometheus. O código de status do HTTP permanece em 200.

Para obter a lista completa dos limites do PromQL, incluindo TPS, simultaneidade e janelas de verificação de 24 horas, consulte Limites e restrições do PromQL.

Amostra de solicitações

A solicitação POST a seguir usa um seletor de correspondência exata. O seletor, o start e o end são passados como campos codificados em formulário no corpo da solicitação. Caracteres especiais como {, }, " e , são codificados por porcentagem. O valor match[] decodificado é {"http.server.active_requests","@resource.service.name"="myservice"}.

POST /api/v1/series HTTP/1.1 Host: monitoring.us-east-1.amazonaws.com Content-Type: application/x-www-form-urlencoded Authorization: AUTHPARAMS X-Amz-Date: 20260605T193725Z User-Agent: awscurl/0.36 match%5B%5D=%7B%22http.server.active_requests%22%2C%22%40resource.service.name%22%3D%22myservice%22%7D&start=1780662000&end=1780665600

A solicitação POST a seguir usa um seletor de correspondência regex. O valor match[] decodificado é {"http.server.active_requests","@aws.region"=~"us-.*"}.

POST /api/v1/series HTTP/1.1 Host: monitoring.us-east-1.amazonaws.com Content-Type: application/x-www-form-urlencoded Authorization: AUTHPARAMS X-Amz-Date: 20260605T193725Z User-Agent: awscurl/0.36 match%5B%5D=%7B%22http.server.active_requests%22%2C%22%40aws.region%22%3D~%22us-.*%22%7D&start=1780662000&end=1780665600

A mesma chamada com awscurl:

awscurl --service monitoring --region us-east-1 \ -X POST 'https://monitoring.us-east-1.amazonaws.com/api/v1/series' \ -H 'Content-Type: application/x-www-form-urlencoded' \ -d 'match[]={"http.server.active_requests","@aws.region"=~"us-.*"}&start=1780662000&end=1780665600'

Exemplo de resposta

Uma resposta bem-sucedida usa o envelope JSON padrão do Prometheus. O campo data é uma matriz de mapas de rótulos, um por série correspondente.

HTTP/1.1 200 OK x-amzn-RequestId: 12345678-abcd-4442-b8c5-262b45e9b535 Content-Type: application/json { "status": "success", "data": [ { "__name__": "http.server.active_requests", "@resource.service.name": "myservice", "@aws.region": "us-east-1" }, { "__name__": "http.server.active_requests", "@resource.service.name": "myservice", "@aws.region": "us-west-2" } ] }