REST Resource: alerts

Zasób: alert

Alert dotyczący klienta.

Zapis JSON 
{
  "customerId": string,
  "alertId": string,
  "createTime": string,
  "startTime": string,
  "endTime": string,
  "type": string,
  "source": string,
  "data": {
    "@type": string,
    field1: ...,
    ...
  },
  "securityInvestigationToolLink": string,
  "deleted": boolean,
  "metadata": {
    object (AlertMetadata)
  },
  "updateTime": string,
  "etag": string
}
Pola
customerId

string

Tylko dane wyjściowe. Unikalny identyfikator konta Google Workspace klienta.
alertId

string

Tylko dane wyjściowe. Unikalny identyfikator alertu.
createTime

string (Timestamp format)

Tylko dane wyjściowe. Czas utworzenia tego alertu.
startTime

string (Timestamp format)

Wymagane. Czas uruchomienia lub wykrycia zdarzenia, które spowodowało ten alert.
endTime

string (Timestamp format)

Opcjonalnie: Godzina, o której zdarzenie, które wywołało ten alert, przestało być aktywne. Jeśli zostanie podany, czas zakończenia nie może być wcześniej niż godzina rozpoczęcia. Jeśli nie zostanie podana, oznacza to, że alert trwa.
type

string

Wymagane. Typ alertu. Te dane są wyświetlane dopiero po utworzeniu alertu. Listę dostępnych typów alertów znajdziesz w artykule Typy alertów Google Workspace.
source

string

Wymagane. Unikalny identyfikator systemu, który zgłosił alert. Te dane są wyświetlane dopiero po utworzeniu alertu.

Obsługiwane źródła to:

  • Google Operations
  • Zarządzanie urządzeniami mobilnymi
  • Wyłudzanie informacji w Gmailu
  • Zapobieganie utracie danych
  • Eksportowanie danych z całej domeny
  • Atak finansowany przez rząd jakiegoś kraju
  • Tożsamość Google
  • Przerwa w dostępie do aplikacji
data

object

Opcjonalnie: Dane powiązane z tym alertem, na przykład google.apps.alertcenter.type.DeviceCompromised.
deleted

boolean

Tylko dane wyjściowe. True, jeśli ten alert jest oznaczony do usunięcia.
metadata

object (AlertMetadata)

Tylko dane wyjściowe. Metadane powiązane z tym alertem.
updateTime

string (Timestamp format)

Tylko dane wyjściowe. Czas ostatniej aktualizacji tego alertu.
etag

string

Opcjonalnie: Funkcja etag zapewnia optymistyczną kontrolę równoczesności, co zapobiega nadpisywaniu alertów jednocześnie. Zdecydowanie zalecamy, aby systemy używały etag w cyklu odczytu, modyfikacji i zapisu do aktualizowania alertów w celu uniknięcia sytuacji wyścigu. W odpowiedzi, która zawiera alerty, zwracany jest etag. System powinien umieścić ten znacznik w żądaniu alertu o aktualizacji, aby mieć pewność, że zmiana zostanie zastosowana do tej samej wersji alertu.

Jeśli w wywołaniu alertu o aktualizacji nie podano żadnego elementu etag, istniejący alert zostanie zastąpiony na ślepo.

AlertMetadata

Metadane alertu.

Zapis JSON 
{
  "customerId": string,
  "alertId": string,
  "status": string,
  "assignee": string,
  "updateTime": string,
  "severity": string,
  "etag": string
}
Pola
customerId

string

Tylko dane wyjściowe. Unikalny identyfikator konta Google Workspace klienta.
alertId

string

Tylko dane wyjściowe. Identyfikator alertu.
status

string

Bieżący stan alertu. Obsługiwane wartości:

  • NOT_STARTED
  • IN_PROGRESS
  • ZAMKNIĘTE
assignee

string

Adres e-mail użytkownika przypisanego do alertu.
updateTime

string (Timestamp format)

Tylko dane wyjściowe. Czas ostatniej aktualizacji metadanych.
severity

string

Wartość wagi alertu. Centrum alertów ustawi to pole podczas tworzenia alertu. Jeśli nie można go określić, domyślnie zostanie ustawiony pusty ciąg znaków. Obsługiwane wartości działań aktualizacji w tym polu to:

  • WYSOKI
  • ŚREDNI
  • NISKI
etag

string

Opcjonalnie: Funkcja etag zapewnia optymistyczną kontrolę równoczesności i zapobiega zastępowaniu się nawzajem przez jednoczesne aktualizacje metadanych alertu. Zdecydowanie zalecamy, aby systemy używały etag w cyklu odczytu, modyfikacji i zapisu do aktualizowania metadanych, aby uniknąć warunków wyścigu. W odpowiedzi, która zawiera metadane alertu, zwracany jest identyfikator etag. Systemy powinny umieścić ten znacznik w żądaniu w celu zaktualizowania metadanych alertu, aby zmiana została zastosowana do tej samej wersji metadanych alertu.

Jeśli w wywołaniu dotyczącym aktualizacji metadanych alertu nie podano żadnego elementu etag, istniejące metadane alertu zostaną zastąpione na ślepo.

Metody

batchDelete

 Wykonuje operacje usuwania zbiorczego w przypadku alertów.

batchUndelete

 Przeprowadza zbiorczą operację przywracania alertów.

delete

 Oznacza określony alert do usunięcia.

get

 Pobiera określony alert.

getMetadata

 Zwraca metadane alertu.

list

 Wyświetla listę alertów.

undelete

 Przywraca lub cofa usunięcie alertu, który został oznaczony do usunięcia w ciągu ostatnich 30 dni.