Saltar al contenido principal
Versión: 4.42

Referencia de la API — Consulta de eventos

Descripción general​

La API de administración expone tres tipos de eventos que puedes consultar y exportar:

  • Eventos de certificado: registran cada uso de un certificado (firma, autenticación, operaciones denegadas por política).
  • Eventos de sistema: registran las acciones realizadas en la consola de administración (cambios de configuración, gestión de usuarios, creación de políticas).
  • Eventos de HA: registran la actividad del clúster de alta disponibilidad.

Antes de empezar​

Antes de probar estos métodos, necesitas configurar SoapUI.

important

Los comentarios <!--Optional:--> que aparecen en las solicitudes SOAP se generan automáticamente y pueden marcar de forma incorrecta campos obligatorios como opcionales.

Esta documentación indica explícitamente qué campos son obligatorios u opcionales. Confía siempre en esta documentación.

Eventos de certificado​

ListEvents​

Devuelve la lista de eventos de uso de certificados que coinciden con los parámetros indicados, ordenados por fecha.

NombreTipoRequeridoDescripción
filterstringNoTexto que deben contener los resultados. Si está vacío, devuelve todos los eventos.
numBlockintegerSíNúmero de bloque de resultados a devolver (paginación). El primer bloque es 0.
orderColumnstringSíColumna de ordenación: ORDER_BY_DATE, ORDER_BY_IP, ORDER_BY_USER, ORDER_BY_CONTEXT, ORDER_BY_CERTIFICATE, ORDER_BY_DESCRIPTION, ORDER_BY_URL.
orderTypestringSíDirección de ordenación: ORDER_ASCENDING, ORDER_DESCENDING.
filterTypestringSíFiltra por tipo de evento: NO_FILTER, FILTER_BY_SECURITY (sesión), FILTER_BY_CERTIFICATE_OPERATION (uso de certificado), FILTER_BY_PERMISSION_DENIED, FILTER_BY_PERMISSION_ALLOWED, FILTER_BY_CERT_LIFECYCLE.
dateFilterTypestringSíFiltro de fecha predefinido: NO_DATE_FILTER, DATE_FILTER_TODAY, DATE_FILTER_THIS_WEEK, DATE_FILTER_THIS_MONTH, DATE_FILTER_LAST_THREE_MONTHS, DATE_FILTER_LAST_SIX_MONTHS, DATE_FILTER_THIS_YEAR, DATE_FILTER_CUSTOM_FILTER. Usa DATE_FILTER_CUSTOM_FILTER para especificar un rango con from y to.
fromdatetimeNoFecha de inicio del rango personalizado. Solo se usa cuando dateFilterType es DATE_FILTER_CUSTOM_FILTER.
todatetimeNoFecha de fin del rango personalizado. Solo se usa cuando dateFilterType es DATE_FILTER_CUSTOM_FILTER.
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
<soap:Header/>
<soap:Body>
<urn:ListEvents>
<urn:filter></urn:filter>
<urn:numBlock>0</urn:numBlock>
<urn:orderColumn>ORDER_BY_DATE</urn:orderColumn>
<urn:orderType>ORDER_DESCENDING</urn:orderType>
<urn:filterType>NO_FILTER</urn:filterType>
<urn:dateFilterType>DATE_FILTER_TODAY</urn:dateFilterType>
</urn:ListEvents>
</soap:Body>
</soap:Envelope>

Eventos de sistema​

ListSystemEvents​

Devuelve la lista de eventos de actividad en la consola de administración que coinciden con los parámetros indicados, ordenados por fecha.

NombreTipoRequeridoDescripción
filterstringNoTexto que deben contener los resultados. Si está vacío, devuelve todos los eventos.
numBlockintegerSíNúmero de bloque de resultados a devolver (paginación). El primer bloque es 0.
orderColumnstringSíColumna de ordenación: ORDER_BY_DATE, ORDER_BY_IP, ORDER_BY_USER, ORDER_BY_SECTION, ORDER_BY_INFORMATION.
orderTypestringSíDirección de ordenación: ORDER_ASCENDING, ORDER_DESCENDING.
dateFilterTypestringSíFiltro de fecha predefinido. Mismos valores que en ListEvents.
fromdatetimeNoFecha de inicio del rango personalizado. Solo se usa cuando dateFilterType es DATE_FILTER_CUSTOM_FILTER.
todatetimeNoFecha de fin del rango personalizado. Solo se usa cuando dateFilterType es DATE_FILTER_CUSTOM_FILTER.
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
<soap:Header/>
<soap:Body>
<urn:ListSystemEvents>
<urn:filter></urn:filter>
<urn:numBlock>0</urn:numBlock>
<urn:orderColumn>ORDER_BY_DATE</urn:orderColumn>
<urn:orderType>ORDER_DESCENDING</urn:orderType>
<urn:dateFilterType>DATE_FILTER_THIS_WEEK</urn:dateFilterType>
</urn:ListSystemEvents>
</soap:Body>
</soap:Envelope>

Eventos de HA​

ListHAEvents​

Devuelve la lista de eventos del clúster de alta disponibilidad que coinciden con los parámetros indicados, ordenados por fecha. Devuelve objetos SystemEventView con el mismo formato que ListSystemEvents.

NombreTipoRequeridoDescripción
filterstringNoTexto que deben contener los resultados. Si está vacío, devuelve todos los eventos.
numBlockintegerSíNúmero de bloque de resultados a devolver (paginación). El primer bloque es 0.
orderColumnstringSíColumna de ordenación: ORDER_BY_DATE, ORDER_BY_IP, ORDER_BY_USER, ORDER_BY_SECTION, ORDER_BY_INFORMATION.
orderTypestringSíDirección de ordenación: ORDER_ASCENDING, ORDER_DESCENDING.
dateFilterTypestringSíFiltro de fecha predefinido. Mismos valores que en ListEvents.
fromdatetimeNoFecha de inicio del rango personalizado. Solo se usa cuando dateFilterType es DATE_FILTER_CUSTOM_FILTER.
todatetimeNoFecha de fin del rango personalizado. Solo se usa cuando dateFilterType es DATE_FILTER_CUSTOM_FILTER.
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
<soap:Header/>
<soap:Body>
<urn:ListHAEvents>
<urn:filter></urn:filter>
<urn:numBlock>0</urn:numBlock>
<urn:orderColumn>ORDER_BY_DATE</urn:orderColumn>
<urn:orderType>ORDER_DESCENDING</urn:orderType>
<urn:dateFilterType>NO_DATE_FILTER</urn:dateFilterType>
</urn:ListHAEvents>
</soap:Body>
</soap:Envelope>

Exporta eventos​

DownloadCSVEvents​

Descarga un archivo CSV con los eventos de certificado que coinciden con los parámetros indicados. Los parámetros van en la cabecera SOAP, no en el cuerpo.

NombreTipoRequeridoDescripción
basicFilter (cabecera)stringNoTexto que deben contener los resultados. Si está vacío, incluye todos los eventos.
filterType (cabecera)stringSíFiltra por tipo de evento. Mismos valores que en ListEvents.
dateFilterType (cabecera)stringSíFiltro de fecha predefinido. Mismos valores que en ListEvents.
from (cabecera)datetimeNoFecha de inicio del rango personalizado. Solo se usa cuando dateFilterType es DATE_FILTER_CUSTOM_FILTER.
to (cabecera)datetimeNoFecha de fin del rango personalizado. Solo se usa cuando dateFilterType es DATE_FILTER_CUSTOM_FILTER.
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:urn="urn:evolium:redtrust:administration:ws">
<soap:Header>
<urn:basicFilter></urn:basicFilter>
<urn:filterType>NO_FILTER</urn:filterType>
<urn:dateFilterType>NO_DATE_FILTER</urn:dateFilterType>
</soap:Header>
<soap:Body>
<urn:CSVFilteredWithDatesMessage/>
</soap:Body>
</soap:Envelope>

¿Te ha resultado útil esta página?