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. Godzina utworzenia tego alertu.

startTime

string (Timestamp format)

Wymagany. Czas rozpoczęcia lub wykrycia zdarzenia, które wywołało ten alert.

endTime

string (Timestamp format)

Opcjonalnie. Czas, przez jaki zdarzenie, które spowodowało ten alert, przestał być aktywne. Jeśli została podana, godzina zakończenia nie może być wcześniejsza niż godzina rozpoczęcia. Jeśli nie zostanie podany, wskazuje trwający alert.

type

string

Wymagany. Typ alertu. Dane wyjściowe są generowane dopiero po utworzeniu alertu. Listę dostępnych typów alertów znajdziesz w artykule Typy alertów Google Workspace.

source

string

Wymagany. Unikalny identyfikator systemu, który zgłosił alert. Dane wyjściowe są generowane dopiero po utworzeniu alertu.

Obsługiwane źródła to:

  • Operacje Google
  • 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 został 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. etag jest używany do optymistycznej kontroli równoczesności jako sposobu zapobiegania jednoczesnemu nadpisaniu alertu. Zdecydowanie zalecamy, aby w ramach cyklu odczytu, modyfikacji i zapisu systemy korzystały z etag w trybie do odczytu i zapisu, aby uniknąć warunków wyścigu. Odpowiedź etag z alertami zawiera systemy, które powinny umieścić znacznik w żądaniu aktualizacji alertu, aby zapewnić, że ich zmiana zostanie zastosowana do tej samej wersji alertu.

Jeśli w wezwaniu do zaktualizowania alertu nie ma żadnej wartości etag, istniejący alert jest ślepo zastąpiony.

Metadane alertów

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

Obecny stan alertu. Obsługiwane wartości to:

  • NIE_ROZPOCZĘTO
  • IN_PROGRESS (IN_PROGRESS)
  • ZAMKNIĘTY
assignee

string

Adres e-mail użytkownika przypisanego do alertu.

updateTime

string (Timestamp format)

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

severity

string

Waga alertu. Centrum alertów ustawi to pole podczas tworzenia alertu. Jeśli nie uda się go ustalić, domyślnie zostanie wpisany pusty ciąg znaków. Obsługiwane wartości:

  • WYSOKA
  • ŚREDNI
  • NISKI
etag

string

Opcjonalnie. etag jest używany do optymistycznej kontroli równoczesności, aby zapobiegać jednoczesnemu nadpisywaniu metadanych alertu. Zdecydowanie zalecamy, aby w ramach zmiany metadanych w trybie do odczytu, zapisu i zapisu systemy używały elementu etag w celu uniknięcia uwarunkowań wyścigu. W odpowiedzi na żądanie metadanych zwracano zmienną etag, która w takim przypadku oczekuje aktualizacji tagu.

Jeśli w wywołaniu nie podano wartości etag, aby zaktualizować metadane alertów, istniejące metadane alertów zostaną niezauważone.

Metody

batchDelete

Wykonuje operację usuwania zbiorczego w alertach.

batchUndelete

Wykonuje operację przywracania zbiorczego w alertach.

delete

Oznacza określony alert do usunięcia.

get

Pobiera określony alert.

getMetadata

Zwraca metadane alertu.

list

Wyświetla listę alertów.

undelete

Powoduje przywrócenie alertu „cofniętych” w ciągu ostatnich 30 dni.