Visualiza registros mediante la API

Estás consultando la documentación de Apigee Edge.
Consulta la documentación de Apigee X.
Información

Descarga los registros de supervisión de la API a fin de ver los datos sin procesar que se usaron para calcular las métricas que se muestran en los paneles de supervisión de la API. Puedes descargar registros para intervalos de tiempo personalizados, proxies específicos, códigos de estado específicos y muchas otras variables.

Nota: De forma predeterminada, las llamadas a la API de registros solo muestran resultados con los códigos de estado 4xx y 5xx, pero no con el código 2xx. Esto se hace para limitar la cantidad de resultados, ya que la mayoría de ellos tienen el código de estado 2xx. Para obtener resultados con el código de estado 2xx, agrega status=2xx a la solicitud. Por ejemplo: https://apimonitoring.enterprise.apigee.com/logs?status=2xx.

En las siguientes secciones, se describe cómo administrar los registros mediante la API:

Consulta API de registros para obtener más información sobre la API de registros.

Para obtener información sobre las opciones de cURL que se usan en estos ejemplos, consulta Usa cURL.

Descarga registros para una organización y un entorno

Descarga los registros de una organización y un entorno específicos mediante la API de registros:

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

Debes pasar el nombre de la organización y el entorno con los parámetros de consulta org y env.

De forma predeterminada, la API muestra las 10 entradas de registro más recientes de la hora anterior. Por ejemplo:

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

Configura $ACCESS_TOKEN como tu token de acceso de OAuth 2.0, como se describe en Obtén un token de acceso de OAuth 2.0.

La respuesta es un arreglo de entradas de registro con el siguiente 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"
  },
  …
]

Usa los parámetros de consulta from y to para especificar un intervalo de tiempo con formato ISO. El formato de la fecha puede ser uno de los siguientes:

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

Por ejemplo:

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"

La API tiene muchos parámetros de consulta opcionales. Por ejemplo, para ver los registros de un proxy llamado myAPI que genera respuestas HTTP 404, haz lo siguiente:

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 mostrar más de 10 entradas de registro, establece el parámetro de consulta limit. Puedes establecerlo en un 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 ver más opciones, consulta la API de registros.

Obtén una lista de los proxies asociados con un host virtual y una ruta base

Un host virtual en un router perimetral te permite especificar un nombre de dominio, un protocolo (como HTTP/HTTPS) y un número de puerto. Por ejemplo, define un host virtual en un router perimetral con la siguiente configuración:

  • alias de host = apis.acme.com
  • port = 443
  • TLS habilitada

Según esta configuración, una solicitud a un proxy de API asociado con este host virtual utiliza el siguiente formulario:

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

Aquí:

  • proxy-base-path se define cuando creas un proxy de API y es único para cada proxy de API.
  • resource-path es la ruta a un recurso al que se puede acceder a través del proxy de API.

Para obtener más información sobre los hosts virtuales, consulta Acerca de los hosts virtuales.

Descarga la lista de proxies de API asociados con un host virtual específico y una ruta base mediante la emisión de una solicitud GET al siguiente recurso de la API de registros:

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

Debes pasar el nombre de la organización y el entorno mediante los parámetros de consulta org y env, así como el URI asociado con el host virtual y la ruta base.

Por ejemplo, la siguiente llamada a la API muestra los proxies asociados con el host virtual http://apis.acme.com y con una ruta 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" 

Configura $ACCESS_TOKEN como tu token de acceso de OAuth 2.0, como se describe en Obtén un token de acceso de OAuth 2.0.

Para ver más opciones, consulta la API de registros.