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 rozpoczęcia lub wykrycia zdarzenia, które spowodowało ten alert.
endTime

string (Timestamp format)

Opcjonalnie: Czas, w którym zdarzenie, które spowodowało ten alert, przestało być aktywne. Jeśli czas zakończenia jest podany, nie może być wcześniejszy niż czas rozpoczęcia. Jeśli nie jest podany, oznacza to, że alert jest nadal aktywny.
type

string

Wymagane. Typ alertu. Jest to dane wyjściowe tylko 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. Jest to dane wyjściowe tylko 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
  • Tożsamość Google
  • Przerwa w dostępie do aplikacji
data

object

Opcjonalnie: Dane powiązane z tym alertem, np. 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: etag służy do kontroli optymizmu w przypadku współbieżności, aby zapobiec nadpisywaniu się wzajemnie przez równoczesne aktualizacje alertu. Zdecydowanie zalecamy, aby systemy korzystały z wartości etag w cyklu odczyt-modyfikacja-zapis w celu aktualizowania alertów, aby uniknąć warunków wyścigu: w odpowiedzi zawierającej alerty zwracana jest wartość etag, a systemy powinny umieścić tę etykietę w żądaniu aktualizacji alertu, aby mieć pewność, że zmiana zostanie zastosowana do tej samej wersji alertu.

Jeśli w wywołaniu do aktualizacji alertu nie ma parametru etag, istniejący alert zostanie zastąpiony bez ostrzeżenia.

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 to:

  • 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 tych metadanych.
severity

string

Wartość wagi alertu. Centrum alertów ustawia to pole podczas tworzenia alertu. Jeśli nie można go określić, domyślnie jest to pusty ciąg znaków. Obsługiwane wartości działań związanych z aktualizacją tego pola to:

  • WYSOKI
  • ŚREDNI
  • NISKI
etag

string

Opcjonalnie: etag służy do kontroli współbieżności optymistycznych, aby zapobiec nadpisywaniu się wzajemnie przez równoczesne aktualizacje metadanych alertu. Zdecydowanie zalecamy, aby systemy korzystały z wartości etag w cyklu odczyt-modyfikacja-zapis w celu aktualizowania metadanych, aby uniknąć warunków wyścigu: w odpowiedzi zwracana jest wartość etag, która zawiera metadane alertu. Systemy powinny umieścić ten tag w żądaniu aktualizującym metadane alertu, aby mieć pewność, że zmiana zostanie zastosowana do tej samej wersji metadanych alertu.

Jeśli w wywołaniu do metody update alert metadata nie podasz parametru etag, istniejące metadane alertu zostaną zastąpione bez ostrzeżenia.

Metody

batchDelete

 Przeprowadza operacje usuwania zbiorczego alertów.

batchUndelete

 Przeprowadza zbiorcze przywracanie alertów.

delete

 Oznacza wskazany alert do usunięcia.

get

 Pobiera podany alert.

getMetadata

 Zwraca metadane alertu.

list

 Wyświetla listę alertów.

undelete

 przywraca lub „odwraca” usunięcie alertu, który został oznaczony do usunięcia w ciągu ostatnich 30 dni;