Sammlung und Bereinigung von REST- und SOAP-API-Analytics
API-Analysen verwenden regelmäßige Aufgaben, um Analysedaten zu sammeln und zu bereinigen.
Die Instanz verfolgt alle Webservicetransaktionen für APIs in der Aufnahmeliste und verwaltet einen täglichen Verlauf, der nach einer Kombination aus Ressource und HTTP-Aktion aggregiert wird. Die Informationen der anfordernden Person werden pro Kombination aus anfordernder Person, Ressource und HTTP-Aktion zusammengefasst und bis zum von der Eigenschaft definierten Tageslimit nachverfolgt com.glide.api.stats.daily_ limit.
| API-Name | Beispielressource | Antwortcode | Beschreibung | Protokolliert |
|---|---|---|---|---|
| now/table | /api/now/table/incident | Alle außer 401 | Gültige Ressource und Tabelle | Ja |
| now/table | /api/now/table/invalidResource | 400 | Gültige Ressource, aber eine ungültige Tabelle | Ja |
| now/table | /api/now/table/incident | 403 | Der anfordernde Benutzer verfügt nicht über ausreichende Berechtigungen | Ja |
| now/table | /api/now/table/incident | 401 | Der anfordernde Benutzer ist nicht authentifiziert | Nein |
| myApp/myScriptedApi | myApp/myScriptedApi/myResource | Alle außer 401 | Gültige Ressource | Ja |
| myApp/invalidApiName |
|
400 | Ungültige API, auch mit einem übereinstimmenden Aufnahmelisteneintrag | Nein |
Die regelmäßige Aufgabe der monatlichen API-Statistiken berechnet am 2. jedes Monats die monatliche Summe für jede Kombination aus Ressource und HTTP-Aktion. Die regelmäßige Aufgabe der monatlichen API-Statistiken berechnet jeden Tag die monatliche Gesamtsumme für jede Kombination aus Ressource, Anforderer und HTTP-Aktion basierend auf den Tagesergebnissen, die älter als zwei Tage sind.
Die täglichen Statistiken werden 33 Tage lang geführt. Die monatlichen Summen werden 13 Monate lang geführt. Tabellenreiniger für die Tabellen „sys_api_stats“, „sys_api_stats_requestor“ und „sys_api_stats_requestor_monthly“ entfernen Analysedatensätze, die älter als diese Grenzwerte sind.
REST- und SOAP-API-Analysen – Namensgebung
Der bei der Nachverfolgung der API-Analysen verwendete API-Name wird vom Typ der beschriebenen API bestimmt, z. B. einer REST-API oder einem geskripteten SOAP-Service.
| API-Typ | Beschreibung |
|---|---|
| REST | Der API-Namespace und der erste Teil des URI, der auf den Namespace folgt, werden als API-Name verwendet. Zum Beispiel sind für die Table-API-Endpunkte api/now/table/incident und api/now/table/problem der Namespace und die ID now/table. |
| Direct SOAP (Tabelle erweitert nicht die Tabellenzeile Import Set) | Wenn die direkte SOAP-Anforderung auf eine Tabelle zugreift, wird „Direct SOAP“ als API-Name verwendet. |
| SOAP-Import (Tabelle erweitert die Tabellenzeile Import Set) | Import Set-SOAP wird als API-Name verwendet. |
| Geskriptete SOAP-Services | Die Seite des SOAP-Anforderungsendpunkts wird als API-Name verwendet, z. B. „my_service.do“. |