Você está lendo a documentação do Apigee Edge.
Acesse a
documentação da Apigee X. info
Use a /metrics/events API para acessar todos os eventos de uma organização por um intervalo de tempo especificado. A lista de eventos inclui todos os alertas detectados pelo Edge.
Por padrão, a API retorna todos os eventos da hora anterior.
Use os parâmetros de consulta from e to para especificar uma duração diferente.
Os valores do parâmetro de consulta from e to são compatíveis com os seguintes formatos:
now(horário local atual)-<value><unit>especifica um horário no passado (observe o hífen à esquerda):<value>– um número inteiro<unit>– uma unidade de tempo de:s, sec, second, m, min, minute, h, hr, hour, d, day
- Uma data formatada em ISO como:
yyyy-mm-ddThh:mm:ssZyyyy-mm-ddThh:mm:ss+00:00
Exemplo:
now- -
1h -10min2019-05-13T14:04:00+00:00
Apenas o parâmetro de consulta org é obrigatório. A seguinte chamada de API retorna todos os eventos na organização myorg referentes às 12 horas anteriores:
curl -H "Authorization: Bearer $ACCESS_TOKEN" \ "https://apimonitoring.enterprise.apigee.com/metrics/events?org=myorg&from=-12h&to=now"
Defina $ACCESS_TOKEN como token de acesso do OAuth 2.0, conforme descrito em Receber um token de acesso do OAuth 2.0. Para informações sobre as opções de curl usadas neste exemplo, consulte Usar curl.
Essa API é compatível com os seguintes parâmetros de consulta opcionais:
| Nome | Descrição | Padrão |
|---|---|---|
from
|
O início do intervalo de tempo para o qual os alertas precisam ser buscados. O valor padrão é o horário atual menos uma hora. Consulte a descrição acima sobre como definir esse parâmetro. | -1h |
to
|
O fim do intervalo de tempo para o qual os alertas precisam ser buscados. O valor padrão é o horário atual. Consulte a descrição acima sobre como definir esse parâmetro. | agora |
alertId
|
Filtra os resultados do histórico de alertas pelo ID de definição de alerta especificado. | Todos os IDs de alerta |
env
|
Filtra eventos pelo ambiente especificado. | Todos os ambientes |
name
|
Filtra eventos pelo nome de alerta especificado. | Todos os nomes de alerta |
region
|
Filtra eventos pela região especificada. | Todas as regiões |
type
|
Filtra eventos pelo tipo especificado: alert.
|
Todos os tipos |