Pular para o conteúdo principal
Version: 4.42

Referência da API — Consulta de eventos

Visão geral

A API de Administração disponibiliza três tipos de eventos que você pode consultar e exportar:

  • Eventos de certificado: registram cada uso de certificado (assinatura, autenticação, operações negadas por política).
  • Eventos do sistema: registram ações realizadas no console de administração (alterações de configuração, gestão de usuários, criação de políticas).
  • Eventos de HA: registram a atividade do cluster de alta disponibilidade.

Antes de começar

Antes de testar estes métodos, você precisa configurar o SoapUI.

important

Os comentários <!--Optional:--> que aparecem nas requisições SOAP são gerados automaticamente e podem marcar incorretamente campos obrigatórios como opcionais.

Esta documentação indica explicitamente quais campos são obrigatórios ou opcionais. Sempre siga esta documentação.

Eventos de certificado

ListEvents

Retorna a lista de eventos de uso de certificados que correspondem aos parâmetros especificados, ordenados por data.

NomeTipoObrigatórioDescrição
filterstringNãoTexto que os resultados devem conter. Se vazio, retorna todos os eventos.
numBlockintegerSimNúmero do bloco de resultados a retornar (paginação). O primeiro bloco é 0.
orderColumnstringSimColuna de ordenação: ORDER_BY_DATE, ORDER_BY_IP, ORDER_BY_USER, ORDER_BY_CONTEXT, ORDER_BY_CERTIFICATE, ORDER_BY_DESCRIPTION, ORDER_BY_URL.
orderTypestringSimDireção da ordenação: ORDER_ASCENDING, ORDER_DESCENDING.
filterTypestringSimFiltra por tipo de evento: NO_FILTER, FILTER_BY_SECURITY (sessão), FILTER_BY_CERTIFICATE_OPERATION (uso de certificado), FILTER_BY_PERMISSION_DENIED, FILTER_BY_PERMISSION_ALLOWED, FILTER_BY_CERT_LIFECYCLE.
dateFilterTypestringSimFiltro de data 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. Use DATE_FILTER_CUSTOM_FILTER para especificar um intervalo com from e to.
fromdatetimeNãoData de início do intervalo personalizado. Usado apenas quando dateFilterType é DATE_FILTER_CUSTOM_FILTER.
todatetimeNãoData de fim do intervalo personalizado. Usado apenas quando dateFilterType é 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 do sistema

ListSystemEvents

Retorna a lista de eventos de atividade do console de administração que correspondem aos parâmetros especificados, ordenados por data.

NomeTipoObrigatórioDescrição
filterstringNãoTexto que os resultados devem conter. Se vazio, retorna todos os eventos.
numBlockintegerSimNúmero do bloco de resultados a retornar (paginação). O primeiro bloco é 0.
orderColumnstringSimColuna de ordenação: ORDER_BY_DATE, ORDER_BY_IP, ORDER_BY_USER, ORDER_BY_SECTION, ORDER_BY_INFORMATION.
orderTypestringSimDireção da ordenação: ORDER_ASCENDING, ORDER_DESCENDING.
dateFilterTypestringSimFiltro de data predefinido. Mesmos valores de ListEvents.
fromdatetimeNãoData de início do intervalo personalizado. Usado apenas quando dateFilterType é DATE_FILTER_CUSTOM_FILTER.
todatetimeNãoData de fim do intervalo personalizado. Usado apenas quando dateFilterType é 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

Retorna a lista de eventos do cluster de alta disponibilidade que correspondem aos parâmetros especificados, ordenados por data. Retorna objetos SystemEventView no mesmo formato que ListSystemEvents.

NomeTipoObrigatórioDescrição
filterstringNãoTexto que os resultados devem conter. Se vazio, retorna todos os eventos.
numBlockintegerSimNúmero do bloco de resultados a retornar (paginação). O primeiro bloco é 0.
orderColumnstringSimColuna de ordenação: ORDER_BY_DATE, ORDER_BY_IP, ORDER_BY_USER, ORDER_BY_SECTION, ORDER_BY_INFORMATION.
orderTypestringSimDireção da ordenação: ORDER_ASCENDING, ORDER_DESCENDING.
dateFilterTypestringSimFiltro de data predefinido. Mesmos valores de ListEvents.
fromdatetimeNãoData de início do intervalo personalizado. Usado apenas quando dateFilterType é DATE_FILTER_CUSTOM_FILTER.
todatetimeNãoData de fim do intervalo personalizado. Usado apenas quando dateFilterType é 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>

Exportar eventos

DownloadCSVEvents

Faz o download de um arquivo CSV com os eventos de certificado que correspondem aos parâmetros especificados. Os parâmetros são enviados no cabeçalho SOAP, não no corpo.

NomeTipoObrigatórioDescrição
basicFilter (cabeçalho)stringNãoTexto que os resultados devem conter. Se vazio, inclui todos os eventos.
filterType (cabeçalho)stringSimFiltra por tipo de evento. Mesmos valores de ListEvents.
dateFilterType (cabeçalho)stringSimFiltro de data predefinido. Mesmos valores de ListEvents.
from (cabeçalho)datetimeNãoData de início do intervalo personalizado. Usado apenas quando dateFilterType é DATE_FILTER_CUSTOM_FILTER.
to (cabeçalho)datetimeNãoData de fim do intervalo personalizado. Usado apenas quando dateFilterType é 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>

Esta página foi útil?