Collecte et nettoyage d’analyses REST et d’API SOAP

L’analyse d’API utilise des travaux planifiés pour collecter et nettoyer les données d’analyse.

L’instance suit toutes les transactions de service Web pour les API figurant sur la liste d’inclusion et gère un historique quotidien, agrégé par ressource et par combinaison d’action HTTP. Les informations du demandeur sont regroupées par combinaison de demandeur, de ressource et d’action HTTP et suivies jusqu’à la limite quotidienne définie par la propriété com.glide.api.stats.daily_ limit.

Consultez la table suivante pour déterminer quelles demandes sont journalisées.

Tableau 1. Demandes consignées

Nom de l'API	Exemple de ressource	Code de réponse	Description	Connecté
now/table	/api/now/table/incident	N’importe lequel sauf 401	Ressource et table valides	Oui
now/table	/api/now/table/invalidResource	400	Ressource valide, mais table non valide	Oui
now/table	/api/now/table/incident	403	L’utilisateur demandeur ne dispose pas de privilèges suffisants	Oui
now/table	/api/now/table/incident	401	L’utilisateur demandeur n’est pas authentifié	Non
myApp/myScriptedApi	myApp/myScriptedApi/myResource	N’importe lequel sauf 401	Ressource valide	Oui
myApp/invalidApiName	myApp/invalidApiName myApp/invalidApiName/myResource	400	API non valide, même avec une entrée de liste d’inclusion correspondante	Non

Le 2 de chaque mois, la tâche planifiée Statistiques mensuelles de l’API calcule le total mensuel pour chaque combinaison de ressource et d’action HTTP. Chaque jour, la tâche planifiée Statistiques mensuelles des demandeurs d’API calcule le total mensuel pour chaque combinaison de ressources, de demandeurs et d’actions HTTP sur la base des scores quotidiens supérieurs à 2 jours.

Les statistiques quotidiennes sont conservées pendant 33 jours. Les totaux mensuels sont maintenus pendant 13 mois. Les nettoyeurs de tables pour les tables sys_api_stats, sys_api_stats_requestor et sys_api_stats_requestor_monthly suppriment les enregistrements d’analyse plus anciens que ces limites.

Dénomination des analyses d’API REST et SOAP

Le nom de l’API utilisé lors du suivi des analyses d’API est déterminé par le type d’API décrit, tel qu’une API REST ou un service SOAP scripté.

Type d'API	Description
REST	L’espace de noms de l’API et la première partie de l’URI qui suit l’espace de noms sont utilisés comme nom de l’API. Par exemple, pour les points de terminaison d’API de table api/now/table/incident et api/now/table/problem, l’espace de noms et l’ID sont now/table.
SOAP direct (la table n’étend pas la table de lignes de jeux d’importation)	Si la demande SOAP directe accède à une table, Direct SOAP est utilisé comme nom d’API.
Importation SOAP (la table étend la table de lignes de jeux d’importation)	Jeu d’importation SOAP est utilisé comme nom d’API.
Services SOAP scriptés	La page du point de terminaison de demande SOAP est utilisée comme nom de l’API, par exemple my_service.do.