Coleta e limpeza de análise de API REST e SOAP
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ão 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.
| Nome da API | Recurso de exemplo | Código de resposta | Descrição | Registrado |
|---|---|---|---|---|
| now/tabela | /api/now/table/incident | Qualquer, exceto 401 | Recurso e tabela válidos | Sim |
| now/tabela | /api/now/table/invalidResource | 400 | Recurso válido, mas uma tabela inválida | Sim |
| now/tabela | /api/now/table/incident | 403 | O usuário solicitante não tem privilégios suficientes | Sim |
| now/tabela | /api/now/table/incident | 401 | O usuário solicitante não está autenticado | Não |
| MyApp/myScriptedApi | MyApp/myScriptedApi/myResource | Qualquer, exceto 401 | Recurso válido | Sim |
| Myapp/invalidApiName |
|
400 | API inválida, mesmo com uma entrada de lista de inclusão correspondente | Não |
No segundo dia de cada mês, o trabalho agendado Estatísticas mensais da API calcula o total mensal para cada combinação de recurso e ação HTTP. Cada dia, o trabalho programado Estatísticas mensais do solicitante da API calcula o total mensal de cada recurso, solicitante e combinação de 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. As limpezas 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 de API REST e SOAP
. Nome da API Usado ao rastrear a análise de 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 Tabela api/now/table/incident e. api/now/table/problem , O namespace e o ID são now/tabela . |
| SOAP direto (a tabela não estende a tabela Linha do conjunto de importação) | Se a solicitação SOAP direta acessar uma tabela, o SOAP direto será usado como o nome da API. |
| Importação SOAP (tabela estende a tabela Linha do conjunto de importação) | O SOAP do conjunto de importação é usado como o nome da API. |
| Serviços SOAP de Script | A página do endpoint de solicitação SOAP é usada como o nome da API, como my_service.do. |