Fragt die Ergebnisse von Aktionen an bestimmten E-Mail-Nachrichten oder Benutzerkonten über Aktionen für Benutzerkonten durchführen- und Aktionen für E-Mail-Nachrichten durchführen-APIs ab.
HTTPS-Anforderung
-
So fragen Sie die Aktionsergebnisse von Benutzerkonten ab:
GET https://<serviceURL>/v1/mitigation/accounts
-
So fragen Sie die Aktionsergebnisse von E-Mail-Nachrichten ab:
GET https://<serviceURL>/v1/mitigation/mails
Anforderungsparameter
Die Anforderung muss die erforderlichen Parameter enthalten.
Parameter |
Beschreibung |
---|---|
Erforderlicher Parameter |
|
batch_id |
Eindeutige ID einer API-Anforderung für Bedrohungsabwehr Um Aktionen abzufragen, die innerhalb einer einzelnen Anforderung durchgeführt wurden, verwenden Sie diesen Parameter. |
start end |
Start- und Endzeit, während der Aktionsergebnisse abgerufen werden sollen. Format: ISO 8601-Zeitstempel auf die Sekunde oder Millisekunde in UTC, yyyy-mm-ddThh: mm: SS[.MMM] Z. Zum Beispiel 2016-07-22T01:51:31Z oder 2016-07-22T01:51:31.001Z. Die Anforderung ruft Protokolle innerhalb von maximal 72 Stunden vor dem Zeitpunkt ab, zu dem die Anforderung gemäß den Einstellungen für start und end gesendet wird:
|
Optionaler Parameter |
|
limit |
Die Anzahl der Aktionsergebnisse, die gleichzeitig angezeigt werden sollen. Es sind maximal 500 zulässig Wenn nicht angegeben, wird der Wert standardmäßig auf 500 festgelegt. Wenn die angeforderten Gesamtergebnisse der Aktion die angegebene Grenze überschreiten, wird im Feld next_link in der Antwort eine URL angegeben. Verwenden Sie diese URL, um eine zweite Anforderung zu erstellen und die verbleibenden Aktionsergebnisse für die vorherige Anforderung abzurufen. Wiederholen Sie dies, bis alle Aktionsergebnisse für die erste Anforderung vorliegen. |
Beispiel anfordern
GET https://api.tmcas.trendmicro.com/v1/mitigation/accounts?batch_id=b97d5470-3bec-11e9-b842-158f7dd62a77 Authorization: Bearer 1de231142eef3f83928da98dc251fbebb6cafe77
Beispiel 2: Abrufen der Ergebnisse von Aktionen, die in Bezug auf E-Mail-Nachrichten von 2019-03-19 03:35:07.000 bis 2019-03-19 05:47:07:000 (UTC) durchgeführt wurden, wobei die Anzahl der gleichzeitig anzuzeigenden Elemente 10 beträgt
GET https://api.tmcas.trendmicro.com/v1/siem/mails?start=2019-03-19T03:35:07.000Z&end=2019-03-19T05:47:07.000Z&limit=10 Authorization: Bearer 1de231142eef3f83928da98dc251fbebb6cafe77
Antwort
Bei Erfolg sendet der Dienst eine HTTP 200-Antwort zurück und gibt einen Antworttext im JSON-Format zurück; andernfalls sendet der Dienst eine Fehlermeldung im JSON-Format mit Fehlerdetails zurück. Weitere Informationen zu Fehlern finden Sie unter API-Antworten.
Antwortbeispiel
HTTP/1.1 200 Content-Type: application/json { "count": 1, "current_link": "https://api.tmcas.trendmicro.com/v1/mitigation/accounts?batch_id=228ab860-46cc-11e9-8071-ff4462689877&limit=1", "next_link": "https://api.tmcas.trendmicro.com/v1/mitigation/accounts?batch_id=228ab860-46cc-11e9-8071-ff4462689877&limit=1&&offset=01", "actions": [ { "action_type": "ACCOUNT_DISABLE", "service": "exchange", "account_provider": "office365", "account_user_email": "user@example.com", "action_id": "24e9de10-46cc-11e9-8071-ff4462689877", "batch_id": "228ab860-46cc-11e9-8071-ff4462689877", "status": "Success", "action_requested_at": "2019-03-04T06:30:21.613Z", "action_executed_at": "2019-03-04T06:30:21.613Z", "error_code": 0, "error_message": "success" } ] }
Antwortfelder
In der folgenden Tabelle werden die verfügbaren Felder für den Antworttext beschrieben.
Alle zeitbezogenen Felder in der Tabelle sind auf Coordinated Universal Time (UTC) eingestellt.
Feld |
Datentyp |
Beschreibung |
---|---|---|
count |
Ganzzahl |
Anzahl der in der aktuellen Antwort zurückgegebenen Aktionsergebnisse |
current_link |
Zeichenfolge |
URL in der aktuellen Anforderung |
next_link |
Zeichenfolge |
URL für die Nachverfolgungsanforderung, wenn die Ergebnisse der angeforderten Aktion die festgelegte Grenze für die gleichzeitige Anzeige überschreiten. Verwenden Sie diese URL, um eine zweite Anforderung zu erstellen und die verbleibenden Aktionsergebnisse für die vorherige Anforderung abzurufen. Wiederholen Sie dies, bis alle Aktionsergebnisse für die erste Anforderung vorliegen. |
actions |
JSON-Array |
Details der angeforderten Aktionsergebnisse |
actions/action_type |
Zeichenfolge |
Aktion, die für eine E-Mail-Nachricht oder ein Benutzerkonto ausgeführt wird |
actions/service |
Zeichenfolge |
Name des geschützten Diensts, auf den die API angewendet wurde |
actions/account_provider |
Zeichenfolge |
Anbieter des geschützten Diensts |
actions/account_user_email |
Zeichenfolge |
E-Mail-Adresse, die zum Erstellen des Benutzerkontos verwendet wird, für das eine Aktion durchgeführt wurde |
actions/mailbox |
Zeichenfolge |
E-Mail-Adresse einer E-Mail-Nachricht, für die eine Aktion durchgeführt wurde |
actions/mail_message_id |
Zeichenfolge |
Internet-Nachrichten-ID einer E-Mail-Nachricht, für die eine Aktion durchgeführt wurde |
actions/mail_unique_id |
Zeichenfolge |
Eindeutige ID einer E-Mail-Nachricht, für die eine Aktion durchgeführt wurde |
actions/action_id |
Zeichenfolge |
Eindeutige ID einer Aufgabe zur Bedrohungsabwehr |
actions/batch_id |
Zeichenfolge |
Eindeutige ID einer API-Anforderung für Bedrohungsabwehr |
actions/status |
Zeichenfolge |
Status einer durchgeführten Aktion. Zu den Optionen gehören:
|
actions/action_requested_at |
ISO 8601-Zeitstempel |
Datum und Uhrzeit, zu der die API-Anforderung mit der Aktion empfangen wurde |
actions/action_executed_at |
ISO 8601-Zeitstempel |
Datum und Uhrzeit der Verarbeitung der Aktion |
actions/error_code |
Ganzzahl |
Ergebniscode der Aktion. Zu den Optionen gehören:
Anmerkung:
Fehlercodes -410, -411 und -412 gelten nur für Exchange Online. |
actions/error_message |
Zeichenfolge |
Zeichenfolge, die den Ergebniscode beschreibt. Zu den einzelnen Fehlercodes gehören folgende Optionen:
|