/policyengine/v1/policyhistory: GET

Recupera información de historial de políticas para todas las políticas.

El /policyengine/v1/policyhistory recupera los detalles del historial de ejecución de políticas para todas las políticas que tiene permiso para ver en el sistema. Las entradas contienen información detallada sobre la ejecución de la política especificada. También proporciona la ubicación del archivo de registro de ejecución.

La tabla siguiente muestra qué roles pueden acceder a este punto final de API REST:
Tabla 1. Acceso por rol
Administrador de datos Usuario de datos Administrador de recopilación Usuario de recopilación Administrador Usuario de servicio
Χ Χ

Sinopsis de la solicitud URL

curl -k -H 'Authorization: Bearer <token>' https://<data_cataloging_host>/policyengine/v1/policyhistory -X GET -H ’Accept: application/json’

Tipos de solicitud y formatos de respuesta soportados

Tipos de solicitud soportados:
  • GET
Formatos de respuesta soportados:
  • JSON

Ejemplos

El ejemplo siguiente devuelve la información del historial de políticas para todas las políticas para las que tiene permisos de visualización.
  1. Emita la siguiente solicitud en una línea.
    curl -k -H 'Authorization: Bearer ${TOKEN}' https://<data_cataloging_host>/policyengine/v1/policyhistory -X GET
  2. Se devuelve la respuesta siguiente.
    [ 
      { 
        "id": 893909178, 
        "policyid": "patent_pol", 
        "state": "complete", 
        "status": null, 
        "starttime": "2020-09-22T20:34:32.000Z", 
        "endtime": "2020-09-22T20:35:19.000Z", 
        "logfile": "/policy_logs/patent_pol-2020-09-22 20:34:32/run.log", 
        "startedby": null, 
        "scheduled": null, 
        "totalcount": 7, 
        "failedcount": 0, 
        "skippedcount": 0, 
        "successcount": 7, 
        "totalsize": null, 
        "policyfilter": "path = '/mnt/datadump/patent_dataset/'", 
        "type": "CONTENTSEARCH", 
        "additional_info": "{\"explicit\": \"true\"}" 
      }, 
      { 
        "id": 3465755378, 
        "policyid": "dicom_hdr_extract", 
        "state": "complete with fail", 
        "status": null, 
        "starttime": "2020-09-22T21:30:59.000Z", 
        "endtime": "2020-09-22T21:31:09.000Z", 
        "logfile": "/policy_logs/dicom_hdr_extract-2020-09-22 21:30:59/run.log", 
        "startedby": null, 
        "scheduled": null, 
        "totalcount": 26, 
        "failedcount": 9, 
        "skippedcount": 0, 
        "successcount": 17, 
        "totalsize": null, 
        "policyfilter": "project='watson_health' and filetype='dcm'", 
        "type": "CONTENTSEARCH", 
        "additional_info": "{\"explicit\": \"true\"}" 
      } 
    ] 

Datos de respuesta

Los datos de respuesta se pueden explicar como se muestra.
ID
La respuesta devuelve el ID de ejecución exclusivo para la ejecución de política especificada.
id_política
La respuesta devuelve el nombre de la política que se está ejecutando.
estado
La respuesta devuelve el estado actual o final de la ejecución de la política.
estado
La respuesta devuelve la información adicional sobre el estado de ejecución (por ejemplo, un mensaje de error).
starttime
La respuesta devuelve la fecha o indicación de fecha y hora en que se inició la ejecución de la política.
endtime
La respuesta devuelve la fecha o indicación de fecha y hora en que se completa la ejecución de la política si la política todavía no se está ejecutando.
logfile
La respuesta devuelve el identificador de archivo de registro para esta ejecución de política.
iniciados por
Este campo de información está reservado para uso futuro.
planificado
Este campo de información está reservado para uso futuro.
recuento total
La respuesta devuelve el número total de registros que cumplen los criterios de filtro de política.
recuento de errores
La respuesta devuelve el número de registros marcados como fallidos durante la ejecución de la política.
recuento de saltos
La respuesta devuelve el número de registros marcados como omitidos durante la ejecución de la política.
recuento satisfactorio
La respuesta devuelve el número de registros que se han marcado como procesados correctamente después de que se haya completado la ejecución de la política.
tamaño total
Este campo de información está reservado para uso futuro.
filtro de políticas
La respuesta devuelve los criterios de filtro que han definido el conjunto de registros que se van a procesar en la ejecución de la política.
tipo
La respuesta devuelve el tipo de política que se está ejecutando.
info_adicional/explícito
La respuesta devuelve el valor booleano que muestra True si la ejecución de la política era para una política definida por el usuario o False si se ha ejecutado para una política generada por el sistema.