Ejemplo: API REST de Log Management

Este ejemplo muestra cómo utilizar la API REST Log Management de operaciones en la nube para solicitar y recuperar registros de los servidores de flujos de trabajo en la suscripción en la nube.

El ejemplo cubre la obtención de una lista de solicitudes de registro, el descubrimiento de los tipos de registro disponibles, la solicitud y la descarga de un registro y finalmente la supresión de solicitudes de registro y de los archivos de registro asociados.
Antes de empezar
Todas las llamadas de API requieren una señal de falsificación de solicitud entre sitios (CSRF) válida en la cabecera IBM-CSRF-TOKEN de la llamada. Obtenga una señal CSRF mediante POST /instance/services/csrf_token. Para obtener más información, consulte Cómo evitar la falsificación de solicitudes entre sitios.
Visualice una lista de las solicitudes de recuperación de registro en la suscripción
Utilice la llamada siguiente para recuperar solicitudes.
GET /instance/services/logs
Puede filtrar solicitudes por entorno, por ejemplo el entorno de desarrollo e incluir la paginación:
GET /instance/services/logs/?environment=dev&offset=5&size=10
Descubra los tipos de registro disponibles
Hay varios tipos diferentes de registros soportados. Para obtener una lista de los tipos de registro habilitados en la suscripción, utilice la llamada siguiente:
GET /instance/services/log_types
La lista incluye el nombre de visualización con posibilidad de traducción para cada tipo de registro y una lista de las propiedades disponibles.
Solicite un tipo de registro específico para un entorno
Utilice la llamada siguiente para solicitar un registro.
POST /instance/services/logs
Los detalles de la solicitud de registro se pasan como objeto JSON en el cuerpo de solicitud de la llamada. Por ejemplo, para solicitar los registros desde el clúster de la aplicación en el entorno de desarrollo, el cuerpo de la llamada debe incluir el entorno y el tipo de registro.
POST /instance/services/logs
	...
	{
	  "environment": "dev",
	  "log_type": "AppCluster"
	}
Según las propiedades soportadas para el tipo de registro puede añadir más criterios de filtro al cuerpo de la llamada estableciendo las propiedades correspondientes en el objeto JSON. Por ejemplo, para solicitar un registro de clúster de aplicación que contenga todos los sucesos registrados entre las 01:07 PM y las 01:17 PM del 16 de agosto de 2019 con un nivel de registro total, utilice la llamada siguiente.
POST /instance/services/logs
	...
	{
	  "environment": "dev",
	  "log_type": "AppCluster",
	  "start_time": "2019-08-16T13:17:22.421Z",
	  "duration": 10,
	  "min_log_level": "all"
	}
La respuesta contiene el ID de registro y el estado y los detalles de la solicitud de registro. Puede utilizar el ID de registro para recuperar el estado, los detalles de la solicitud de registro y el archivo de registro. Si especifica una propiedad no soportada para un tipo de registro, la API devuelve un error. Si no incluye todas las propiedades soportadas, se utilizan valores predeterminados para las propiedades ausentes.
Recupere el registro solicitado
Compruebe el estado de una solicitud de recuperación de registro añadiendo el parámetro log_id a la llamada GET :
GET /instance/services/logs/8015
Cuando la solicitud de registro que se devuelve contiene el estado "available", puede utilizar la siguiente llamada con el tipo de contenido "application/zip" para recuperar el archivo .zip que contiene los registros:
GET /instance/services/logs/8015/file
Suprima las solicitudes de registro y los archivos de registro asociados
Suprima la solicitud de registro y los archivos de registro mediante la llamada siguiente:
DELETE /instance/services/logs/8015