Registros de la API¶

Introducción¶

La página Registros de API dentro de API Manager muestra una tabla de todos los registros de procesamiento de API, así como registros de depurar (si el registro de depurar está habilitado). Los registros se muestran para las APIs personalizadas, OData y Proxy cuando se las llama a través de Pasarela de API en Nube o Pasarela de API Privada.

Hay cuatro tipos de registros que se pueden registrar para una llamada a la API:

• Registros de API: Los registros de API se generan automáticamente en la página Registros de API para cada llamada API de API Manager. Los registros de la API contienen información sobre la llamada de la API, incluida la marca de tiempo de la solicitud de la API, el código de estado HTTP, el ID de la solicitud, el método de la solicitud, el URI de la solicitud, el tiempo de respuesta, la IP de origen de la aplicación de llamada, la aplicación de origen, y cualquier mensaje de registro.
• Registros de depuración de API: Los registros de depurar de API son entradas adicionales en un registro de API existente que rastrea completamente cada solicitud recibida a través de la URL de servicio de una API de API Manager. El registro de depurar de API no está habilitado de forma predeterminada y debe habilitarse en una API de API Manager individual para que los registros de depurar de API se incluyan en un registro de API.
• Registros detallados de API: Los registros detallados de API son entradas adicionales en un registro de API existente que consisten en datos de solicitud y respuesta recibidos o enviados a través de una URL de servicio de API de API Manager. El registro detallado de API no está habilitado de forma predeterminada y debe habilitarse en una API de API Manager individual para que los registros detallados de API se incluyan en un registro de API.
• Registros de operaciones de la API: Los registros de operación de la API contienen el inicio de una llamada a la API y el tiempo transcurrido. A diferencia de los registros de API, los registros de depurar y los registros detallados, los registros de operación de API requieren el uso de un Agente Privado y están habilitados en el archivo de configuración del Agente Privado. Estos registros se registran en el Agente Privado en el jitterbit.log archivo ubicado en el log directorio.

Los datos de registro para registros de API, registros de depurar y registros detallados están disponibles en la página Registros de API durante 90 días a partir de la fecha en que se consume la API.

Para obtener más información sobre cómo habilitar los registros de depurar y los registros detallados, consulte estos recursos:

• Paso 1: Configuración de Configuración API Personalizada
• Paso 1: Configuración de Configuración del Servicio OData
• Paso 1: Configuración básica de Configuración de la proxy de API

Para agregar información de registro adicional para APIs de OData, incluidos los datos SQL enviados a la base de datos, edite el Archivo de configuración del Agente Privado y establecer DebugJDML a true.

Acceso a la Página de Registros de la API¶

Se puede acceder a la página Registros de API desde el menú del Portal de Harmony o desde otras páginas dentro del API Manager:

• Desde el Inicio o Descargas o desde Cloud Studio, Vinyl, Marketplace, Management Console, EDI, o Citizen Integrator, use el menú del Portal de Harmony en la parte superior izquierda para ir a API Manager > Registros de API:

  

• Desde Mis APIs, Administrador del portal, Análisis, Perfiles de seguridad, Grupos de IPs Confiables, o Grupos de API, utilice el menú de navegación del API Manager para seleccionar Registros de API:

  

Encabezado de Página de Registros de API¶

El encabezado en la parte superior de la página Registros de API incluye el menú de navegación del API Manager, una barra de búsqueda, filtros y opciones adicionales:

Puede ajustar los datos que se muestran utilizando los menús desplegables Filtrar por y Ver datos.

Filtrado por¶

Los menús desplegables de Filtrar por le permiten mostrar registros de API según criterios específicos en cualquier combinación de ambientes, APIs, perfiles, códigos de estado o métodos de solicitud.

Cada filtro muestra una lista desplegable de criterios entre los que puede seleccionar uno o varios criterios.

Estos son los criterios disponibles para filtrar:

• Ambientes: Use el menú desplegable para seleccionar los ambientes donde se encuentran las APIs. Cuando no se seleccionan todos los filtros, se muestran los ambientes de todas las APIs de la organización a las que tiene acceso.

• APIs: Use el menú desplegable para seleccionar las APIs publicadas dentro de la organización. Cuando no se seleccionan todos los filtros, se muestran todas las APIs de la organización a las que tiene acceso.

  Nota

  Las APIs publicadas anteriormente que no se publican no aparecerán en el menú desplegable APIs. Los registros de API para estas APIs estarán presentes en la página Registros de API, pero no se pueden filtrar.

• Perfiles: Use el menú desplegable para seleccionar los perfiles de seguridad asignados de las APIs. Cuando no se seleccionan todos los filtros, se muestran todos los perfiles de seguridad de la organización a los que tiene acceso.

• Códigos de estado: Use el menú desplegable para seleccionar los grupos de códigos de estado de respuesta HTTP, seleccionando entre Éxito (2xx), Redirecciones (3xx), Errores de cliente (4xx), y Errores del servidor (5xx). Cuando no se seleccionan todos los filtros, se muestran todos los códigos de estado de respuesta HTTP para las APIs en las organizaciones a las que tiene acceso. Para obtener más información sobre los códigos de estado, consulte estado de w3.org definiciones de código.

• Métodos de solicitud: Use el menú desplegable para seleccionar los métodos de solicitud HTTP, seleccionando GET, PUT, POST, DELETE, PATCH, y COMBINAR. Cuando no se seleccionan todos los filtros, se muestran todos los métodos de solicitud HTTP para las APIs en la organización a la que tiene acceso. Para obtener más información sobre los métodos de solicitud HTTP, consulte métodos de solicitud de w3.org.

Ver Datos¶

La opción Ver datos le permite mostrar registros dentro de un período de tiempo específico. La configuración predeterminada para el período de tiempo es Últimos 7 días.

Use el menú desplegable Ver datos para seleccionar el período de tiempo deseado. Seleccione uno de Últimos 10 minutos, Última 1 hora, Últimas 10 horas, Últimas 24 horas, Últimos 7 días, Último 1 mes o Período personalizado.

Seleccionar Período personalizado le permite mostrar los registros de la API dentro de un período de tiempo específico. Cuando se selecciona esta opción, se muestran campos de calendario adicionales Desde y Hasta:

• Desde: Haga clic para ajustar la fecha y la hora de inicio de los registros de la API.
• Hasta: Haga clic para ajustar la fecha y la hora de finalización de los registros de la API.

Después de hacer clic en los campos de calendario Desde o Hasta, se muestra un cuadro de diálogo de calendario donde puede seleccionar la fecha y la hora:

Buscando¶

La barra de búsqueda le permite filtrar los registros por los criterios de búsqueda proporcionados abajo:

• Solo registros con mensajes: Seleccione para restringir aún más los resultados de búsqueda solo a los registros que incluyen detalles de registro. Los resultados de la búsqueda se actualizarán automáticamente.

Criterio de Búsqueda¶

Estos son los criterios de búsqueda que se pueden utilizar. Se incluyen ejemplos de criterios de búsqueda válidos e inválidos:

Combinar Búsquedas¶

Las búsquedas pueden contener una combinación de criterios. Los criterios de búsqueda combinados deben estar separados por un punto y coma (;) entre cada criterio. Estos son ejemplos de búsquedas combinadas válidas:

message=%Access Denied%;requesturi=%contacts%;

requestid=%yzaccwui%;message=%REJECT%;
requesturi=%contacts%;responsetime<=2;
responsetime>=5;sourceapp=%Chrome%;
responsetime>=5;sourceip=70.5%;
sourceapp=%Chrome%;message=%REJECT%;

sourceapp=%Mozilla%;responsetime<=1;

sourceip=70.5%;requesturi=%contacts%;

Opciones Adicionales¶

Las opciones de registro de API adicionales se muestran en el lado izquierdo de la página, directamente encima de la barra de búsqueda:

• Ver última actualización: Muestra la última vez que se actualizaron los datos de forma dinámica o manual. La hora se muestra en el formato h:mm:ss.

• Actualizar: Haga clic para actualizar los datos de registro según los filtros aplicados y los criterios de búsqueda.

• Descargar como CSV: Haga clic para descargar los datos de registro actuales según los filtros aplicados y los criterios de búsqueda.

  Nota

  El campo de fecha dentro del archivo CSV es una marca de tiempo UNIX que requerirá conversión si desea usar un formato de fecha y hora diferente.

Visualización de Registros de API¶

Cada fila de la tabla de registros de la API muestra los datos de registro de la API para una llamada a la API:

• Marca de tiempo: La marca de tiempo de la solicitud de la API. Los tiempos se muestran en la huso horario de su navegador.
• Código de estado: El código de estado HTTP. Para obtener más información sobre los códigos de estado HTTP, consulte w3.org definiciones de código de estado.
• Solicitud ID: Una ID única para la solicitud API.
• Método de solicitud: El método de solicitud HTTP de la API (GET, PUT, POST, DELETE, PATCH o MERGE).
• Solicitud URI: La URL completa de la API a la que se llamó. Pase el cursor sobre el campo Solicitar URI para ver la URL completa.
• Tiempo de respuesta: La cantidad de tiempo, en milisegundos, que tardó la API en ejecutarse.
• IP de origen: La dirección IP externa de la aplicación o el servidor que llamó a la API.
• Aplicación de origen: La aplicación de origen para la llamada a la API, presente solo cuando la llamada a la API se pasa en un encabezado de solicitud. Pase el cursor sobre la columna Aplicación de origen para ver el contenido del campo.

Cada página muestra 20 registros. Puede ver todos los registros dentro del filtro y los criterios de búsqueda utilizando los botones Siguiente y Anterior.

Visualización de Detalles del Registro¶

Para ver detalles de registro adicionales o registros de depurar (si están habilitados), haga clic en expandir icono en una entrada de registro:

Un registro de API típico contendrá estos detalles:

• Nombre de dominio de la región de Harmony, ruta del servicio y URL base (consulte URL del servicio API)
• Tiempo de procesamiento de llamadas API
• Información del perfil de seguridad, como el tipo de autorización y las credenciales utilizadas
• Detalles de la carga útil, incluida la longitud de la carga útil y el tamaño de la respuesta
• Información de error (si corresponde)
• Registros de depuración (si están habilitados)
• Registros detallados (si están habilitados)