Ver registros usando a API

Você está vendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. informações

Faça o download dos registros da API Monitoring para consultar os dados brutos usados no cálculo das métricas exibidas nos painéis da API Monitoring. É possível fazer o download de registros para intervalos de tempo personalizados, proxies específicos, códigos de status específicos e muitas outras variáveis.

Observação:por padrão, as chamadas para a API Logs só retornam resultados com os códigos de status 4xx e 5xx, mas não com o código 2xx. Isso é feito para limitar o número de resultados, já que a maioria deles tem o código de status 2xx. Para receber resultados com o código de status 2xx, adicione status=2xx à solicitação. Por exemplo, https://apimonitoring.enterprise.apigee.com/logs?status=2xx.

As seções a seguir descrevem como gerenciar registros usando a API:

Consulte API Logs para saber mais sobre a API Logs.

Para informações sobre as opções de cURL usadas nesses exemplos, consulte Usar cURL.

Fazer o download de registros para uma organização e um ambiente

Faça o download dos registros de uma organização e de um ambiente específicos usando a API Logs:

https://apimonitoring.enterprise.apigee.com/logs

É preciso transmitir o nome da organização e do ambiente usando os parâmetros de consulta org e env.

Por padrão, a API retorna as 10 entradas de registro mais recentes da última hora. Exemplo:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

Defina $ACCESS_TOKEN como token de acesso do OAuth 2.0, conforme descrito em Receber um token de acesso do OAuth 2.0.

A resposta é uma matriz de entradas de registro no formato:

[   
  {
"request":"GET /v1/o/myorg/z HTTP/1.1",
    "request_length":1349,
    "request_message_id":"rrt-0623eb157b650315c-c-ne-7785-16029140-1",
    "virtual_host":"api.enterprise.apigee.com",
    "response_size":144,
    "response_time":0.551,
    "response_status":"404",
    "timestamp":"2018-08-14T17:31:07Z",
    "fault_code":"messaging.adaptors.http.flow.ErrorResponseCode",
    "fault_flow":"-",
    "fault_policy":"null/null",
    "fault_proxy":
        "/organizations/myorg/environments/prod/apiproxies/myAPI/revisions/50",
    "fault_source":"target"
  },
  …
]

Use os parâmetros de consulta from e to para especificar um período no formato ISO. O formato da data pode ser:

  • yyyy-mm-ddThh:mm:ssZ
  • yyyy-mm-ddThh:mm:ss+00:00

Exemplo:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod&from=2018-08-13T14%3A04%3A00Z&to=2018-08-13T14%3A10%3A00Z" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

A API tem muitos parâmetros de consulta opcionais. Por exemplo, para ver os registros de um proxy chamado myAPI que gera respostas HTTP 404:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod&proxy=myAPI&status=404" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

Para retornar mais de 10 entradas de registro, defina o parâmetro de consulta limit. É possível defini-lo como um valor máximo de 1.000:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod&proxy=myAPI&status=404&limit=200" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

Para mais opções, consulte a API Logs.

Listar os proxies associados a um host virtual e um caminho base

Um host virtual em um roteador de borda permite especificar um nome de domínio, um protocolo como HTTP/HTTPS e um número de porta. Por exemplo, você define um host virtual em um roteador de borda com as configurações a seguir:

  • alias do host = apis.acme.com
  • porta = 443
  • TLS ativado

Com base nessas configurações, uma solicitação para um proxy de API associado a esse host virtual usa o formulário:

https://apis.acme.com/proxy-base-path/resource-path

Em que:

  • O proxy-base-path é definido quando você cria um proxy de API e é exclusivo para cada proxy de API.
  • resource-path é o caminho para um recurso acessível pelo proxy de API.

Para saber mais sobre hosts virtuais, consulte Sobre hosts virtuais.

Faça o download da lista de proxies de API associados a um host virtual e um caminho base específicos emitindo uma solicitação GET para o seguinte recurso da API Logs:

https://apimonitoring.enterprise.apigee.com/logs/apiproxies

Transmita o nome da organização e do ambiente usando os parâmetros de consulta org e env, além do URI associado ao host virtual e ao caminho base.

Por exemplo, a seguinte chamada de API retorna os proxies associados ao host virtual http://apis.acme.com e com um caminho base de /v1/perf:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs/apiproxies?org=myorg&env=prod&select=http://apis.acme.com/v1/perf" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

Defina $ACCESS_TOKEN como token de acesso do OAuth 2.0, conforme descrito em Receber um token de acesso do OAuth 2.0.

Para mais opções, consulte a API Logs.