Coleta e limpeza de análise de REST e SOAP API

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 2 min. de leitura
  • A análise de API usa trabalhos agendados para coletar e limpar dados de análise.

    A instância rastreia todas as transações de serviço web para APIs na lista de inclusões e mantém um histórico diário, agregado por combinação de recurso e ação HTTP. As informações do solicitante são agregadas por solicitante, recurso e combinação de ação HTTP e rastreadas até o limite diário definido pela propriedade com.glide.api.stats.daily_ limit.

    Consulte a tabela a seguir para determinar quais solicitações são registradas em log.
    Tabela 1. Solicitações registradas
    Nome da API Exemplo de recurso Código de resposta Descrição Registrado
    agora/tabela /api/now/table/incident Qualquer um, exceto 401 Recurso e tabela válidos Sim
    agora/tabela /api/now/table/invalidResource 400 Recurso válido, mas uma tabela inválida Sim
    agora/tabela /api/now/table/incident 403 O usuário solicitante não tem privilégios suficientes Sim
    agora/tabela /api/now/table/incident 401 O usuário solicitante não está autenticado Não
    myApp/myScriptedApi myApp/myScriptedApi/myResource Qualquer um, exceto 401 Recurso válido Sim
    myApp/invalidApiName
    • myApp/invalidApiName
    • myApp/invalidApiName/myResource
    400 API inválida, mesmo com uma entrada na lista de inclusões correspondente Não

    No dia 2 de cada mês, o trabalho agendado de estatísticas mensais da API calcula o total mensal de cada combinação de recurso e ação HTTP. A cada dia, o trabalho agendado de Estatísticas Mensais do Solicitante da API calcula o total mensal de cada combinação de recurso, solicitante e ação HTTP com base em pontuações diárias com mais de 2 dias.

    As estatísticas diárias são mantidas por 33 dias. Os totais mensais são mantidos por 13 meses. Os limpadores de tabela das tabelas sys_api_stats, sys_api_stats_requestor e sys_api_stats_requestor_monthly removem registros de análise mais antigos que esses limites.

    Nomenclatura de análise da REST & SOAP API

    O nome da API usado ao rastrear a análise da API é determinado pelo tipo de API que está sendo descrito, como uma REST API ou um serviço SOAP com script.

    Tipo de API Descrição
    REST O namespace da API e a primeira parte do URI após o namespace são usados como o nome da API.

    Por exemplo, para os endpoints da API de tabela api/now/table/incident e api/now/table/problem, o namespace e o ID são now/table.

    SOAP direto (a tabela não estende a tabela de linhas do conjunto de importação) Se a solicitação SOAP direta acessar uma tabela, SOAP direto será usado como o nome da API.
    Importação SOAP (a tabela estende a tabela Linha do conjunto de importação) O conjunto de importação SOAP é usado como o nome da API.
    Serviços SOAP de Script A página do endpoint da solicitação SOAP é usada como o nome da API, como my_service.do.