Prüfungsunterlagen abrufen

Sie können die API verwenden, um Prüfprotokolle abzurufen.

Verwenden Sie die API, um Prüfdatensätze ( /SP4C/audit -Navigationseigenschaft) für Aktivitäten innerhalb Ihres IBM® Storage -Protect-for-Cloud-Mandanten abzurufen. Das Thema beschreibt die erforderlichen Berechtigungen, verfügbaren Methoden und Modelle, die für die Interaktion mit der API verwendet werden.

Berechtigung

Registrieren Sie eine App über, um Ihren Zugriff auf IBM Storage Schutz für die Cloud > App-Registrierungen zu authentifizieren IBM Graph API und zu autorisieren. Weitere Informationen finden Sie unter "Authentifizierung und Autorisierung ".

Für den Aufruf der API ist die folgende Berechtigung erforderlich.


API	Berechtigung
/sp4c/audit	`audit.read.all`

Anforderung

In diesem Abschnitt werden die Methode HTTP und der Endpunkt beschrieben, die zum Abrufen der Prüfprotokolle verwendet werden.


Methode	Endpunkt	Beschreibung
GET	`/sp4c/audit`	Ruft die Benutzeraktivitäten in Ihrem IBM Storage Protect for Cloud-Tenant innerhalb eines bestimmten Zeitraums ab.

Abfrageparameter

Die API unterstützt die folgenden Abfrageparameter, um den Datenabrufprozess zu verfeinern und anzupassen. Mit den Parametern können die Benutzer Zeitspannen, Produkttypen, geografische Lage und andere Kriterien angeben, um die Ergebnisse zu filtern.


Parameter	Beschreibung	Typ	Erforderlich
`startTime`	Legt eine Startzeit für den Zeitbereich im ISO-8601-Format fest.	`string`	Nein
`endTime`	Legt eine Endzeit für den Zeitbereich im ISO-8601-Format fest. Der Zeitraum zwischen `startTime` und `endTime` darf nicht mehr als sieben Tage betragen.	`string`	Nein
`productTypes`	Wenn für diesen Parameter kein Wert festgelegt ist, ruft die Methode die Prüfdatensätze für alle Produkte in Ihrem IBM Storage Protect for Cloud-Mandanten ab. Um Prüfprotokolle von bestimmten Produkten zu erhalten, verwenden Sie die folgenden Werte: Office365Backup ( IBM Storage Schutz für die Cloud Microsoft™ 365 ) Portal ( IBM Storage Protect for Cloud ) GsuiteBackup ( IBM Storage Protect für Cloud Google Workspace ) CRMBackup ( IBM Storage Protect für Cloud Dynamics 365 )	`string`	Nein
`geoLocations`	Der Parameter ist nur für IBM Storage -Protect-for-Cloud-Mandanten verfügbar, die Multi-Geo unterstützen. Wenn für den Parameter kein Wert festgelegt ist, ruft die Methode die Prüfdatensätze von allen Speicherorten in Ihrem IBM Storage Protect for Cloud-Mandanten ab. Um Prüfprotokolle von den spezifischen Datenzentren zu erhalten, verwenden Sie die folgenden Werte: PrimaryGeoLocation (Zentrale IBM Storage Protect für Cloud-Standort ) NAM (Nordamerika) EUR (Europa/Naher Osten/Afrika) GBR (Vereinigtes Königreich) JPN (Japan) APC (Asien-Pazifik) AUS (Australien) CAN (Kanada) IND (Indien) FRA (Frankreich) ARE (Vereinigte Arabische Emirate) ZAF (Südafrika) CHE (Schweiz) KOR (Korea) DEU (Deutschland) BRA (Brasilien) NOR (Norwegen) SWE (Schweden) Katar POL (Polen) ITA (Italien)	`string`	Nein
`skipToken`	Wenn die Ergebnisse einer Abfrage zu umfangreich sind, um in einer einzigen Antwort zurückgegeben zu werden, wird in der Antwort eine `skipToken` angegeben. Mit dem Token können Benutzer die nächsten Ergebnisse abrufen, indem sie es in einer nachfolgenden Anfrage an die Abfrage URL anhängen.	`string`	Nein

Antwort

Die API-Antwort enthält detaillierte Informationen zu den abgerufenen Prüfdatensätzen.


Code erstellen	Beschreibung	Schema
200	Bei Erfolg gibt die Methode diesen Code zurück.	`ApiResultOfUserActivityModel`
400	Wenn ein Fehler auftritt, gibt die Methode diesen Code zurück.	`ErrorResponse`

Reaktionsmodelle

In den folgenden Abschnitten werden die Reaktionsmodelle der Prüfprotokolle beschrieben.

ApiResultOfUserActivityModel

Das Modell wird nach erfolgreicher Abholung der Prüfprotokolle zurückgegeben.


Ihren Namen	Beschreibung	Typ	Erforderlich
`nextLink`	Wenn mehrere Abfrageanforderungen erforderlich sind, um alle Ergebnisse abzurufen, gibt die Antwort die Eigenschaft `nextLink` zurück und der Wert `nextLink` ist ein URL zur nächsten Ergebnisseite. Sie können die nächste Seite mit Ergebnissen abrufen, indem Sie den Wert URL der Eigenschaft `nextLink` senden.	Zeichenfolge	Nein
`data`	Die Abfrageparameter in der Antwort auf das Abrufen von Prüfprotokollen.	UserActivityAuditLogItemModel	Nein

UserActivityAuditLogItemModel

Bei Erfolg werden die folgenden Objekte im Antworttext angezeigt.


Ihren Namen	Beschreibung	Typ	Erforderlich
`actionName`	Name der Aktion.	Zeichenfolge	Nein
`actionUser`	Nutzer der Aktion.	Zeichenfolge	Nein
`actionParameters`	Nutzer der Aktion.	Zeichenfolge	Nein
`actionTime`	Zeitpunkt der Aktion im ISO-8601-Format.	Zeichenfolge	Nein
`controllerName`	Controller in Aktion.	Zeichenfolge	Nein
`product`	Name des Produkts. Die gültigen Werte sind im Folgenden aufgelistet: IBM Storage Schutz für Cloud Microsoft 365 IBM Storage Schutz für Cloud IBM Storage Schützen für Cloud Google Workspace IBM Storage Schutz für Cloud Dynamics 365	Zeichenfolge	Nein
`geoLocation`	Geografische Standorte eines Mandanten mit mehreren Geodaten.	Zeichenfolge	Nein
`previousValue`	Vorheriger Wert der Aktion.	Zeichenfolge	Nein
`currentValue`	Aktueller Wert der Aktion.	Zeichenfolge	Nein
`partnerTenantOwner`	Der Mieter des Dienstanbieters, der den IBM Storage Protect for Cloud-Mandanten des Kunden verwaltet.	Zeichenfolge	Nein
`status`	Status der Aktion.	Zeichenfolge	Nein
`comment`	Kommentar zur Aktion.	Zeichenfolge	Nein
`objectType`	Typ des Aktionsobjekts.	Zeichenfolge	Nein
`operationType`	Art der Aktion.	Zeichenfolge	Nein
`module`	Modul der Aktion.	Zeichenfolge	Nein
`functionality`	Funktion, die mit der Aktion zusammenhängt.	Zeichenfolge	Nein
`objectName`	Der Name des Objekts, das mit der Aktion in Zusammenhang steht.	Zeichenfolge	Nein
`clientIP`	Öffentliche IP-Adresse für die Aktion.	Zeichenfolge	Nein

ErrorResponse

Wenn ein Fehler auftritt, werden die folgenden Informationen im Antworttext angezeigt.


Ihren Namen	Beschreibung	Typ
`traceId`	Die eindeutige Kennung wird verwendet, um den Fluss einer Anfrage zu verfolgen und nachzuverfolgen.	`string`
`error`	Die Fehlernachricht.	`string`
`statusCode`	Der HTTP Fehlercode.	HttpStatusCode

Muster anfordern

Die folgende Anfrage ist ein API-Aufruf an IBM Storage in der Region USA-Ost. Die API-Methode /sp4c/audit wird verwendet. Diese Anfrage dient dazu, innerhalb eines festgelegten Zeitrahmens und beschränkt auf einen bestimmten geografischen Standort eine bestimmte Gruppe von Audit-Protokollen aus dem Protect for Cloud-Portal von IBM Storage abzurufen.

https://usea-graph.sp4c.storage-defender.ibm.com/sp4c/audit?startTime=2024-10-10T08:00:00Z&endTime=2024-10-14T17:00:00Z&productTypes=Portal&geoLocations=NAM

Rücklaufprobe

Bei Erfolg gibt die Methode einen 200 OK-Antwortcode und eine Sammlung von Benutzeraktivitäten im Antworttext zurück.

{
   "nextLink":null,
   "data":[
      {
         "actionName":"Session Timeout",
         "actionUser":"dev@test.onmicrosoft.com",
         "actionParameters":"null",
         "actionTime":"2024-10-14T07:41:50Z",
         "controllerName":"AccountController",
         "product":"IBM Storage Protect for Cloud",
         "geoLocation":null,
         "previousValue":null,
         "currentValue":null,
         "partnerTenantOwner":null,
         "status":null,
         "comment":null,
         "objectType":null,
         "operationType":null,
         "module":null,
         "functionality":null,
         "objectName":null,
         "clientIP":"123.123.12.123"
      }
   ]
}