REST Resource: alerts

Risorsa: avviso

Un avviso relativo a un cliente.

Rappresentazione 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
}
Campi
customerId

string

Solo output. L'identificatore univoco dell'account Google Workspace del cliente.

alertId

string

Solo output. L'identificatore univoco dell'avviso.

createTime

string (Timestamp format)

Solo output. L'ora in cui è stato creato l'avviso.

startTime

string (Timestamp format)

Obbligatorio. L'ora in cui l'evento che ha causato questo avviso è stato avviato o rilevato.

endTime

string (Timestamp format)

(Facoltativo) L'ora in cui l'evento che ha causato questo avviso ha smesso di essere attivo. Se specificata, l'ora di fine non deve essere precedente all'ora di inizio. Se non viene fornito, indica un avviso in corso.

type

string

Obbligatorio. Il tipo di avviso. Questo viene generato solo dopo la creazione dell'avviso. Per un elenco dei tipi di avvisi disponibili, vedi Tipi di avvisi di Google Workspace.

source

string

Obbligatorio. Un identificatore univoco del sistema che ha segnalato l'avviso. Questo viene generato solo dopo la creazione dell'avviso.

Le origini supportate sono:

  • Operazioni di Google
  • Gestione dei dispositivi mobili
  • Phishing Gmail
  • Data Loss Prevention
  • Estrazione a livello di dominio
  • Attacco perpetrato a un sostegno statale
  • Google Identity
  • Interruzione di app
data

object

(Facoltativo) I dati associati a questo avviso, ad esempio google.apps.alertcenter.type.DeviceCompromised.

deleted

boolean

Solo output. True se questo avviso è contrassegnato per l'eliminazione.

metadata

object (AlertMetadata)

Solo output. I metadati associati a questo avviso.

updateTime

string (Timestamp format)

Solo output. L'ora dell'ultimo aggiornamento di questo avviso.

etag

string

(Facoltativo) etag viene utilizzato per il controllo ottimistico della contemporaneità, in modo da impedire che gli aggiornamenti simultanei di un avviso si sovrascrivano a vicenda. È vivamente consigliato che i sistemi utilizzino l'istruzione etag nel ciclo di lettura, modifica e scrittura per eseguire aggiornamenti degli avvisi al fine di evitare le condizioni di gara: nella risposta viene restituito un etag che contiene gli avvisi e i sistemi devono inserire questo tag nella richiesta di aggiornamento dell'avviso per garantire che la modifica venga applicata alla stessa versione dell'avviso.

Se non viene fornito alcun etag nell'avviso di chiamata per aggiornare, l'avviso esistente viene sovrascritto in modo cieco.

AlertMetadata

Un metadati di avviso.

Rappresentazione JSON
{
  "customerId": string,
  "alertId": string,
  "status": string,
  "assignee": string,
  "updateTime": string,
  "severity": string,
  "etag": string
}
Campi
customerId

string

Solo output. L'identificatore univoco dell'account Google Workspace del cliente.

alertId

string

Solo output. L'identificatore dell'avviso.

status

string

Lo stato attuale dell'avviso. I valori supportati sono i seguenti:

  • NOT_STARTED
  • IN_PROGRESS
  • CHIUSO
assignee

string

L'indirizzo email dell'utente assegnato all'avviso.

updateTime

string (Timestamp format)

Solo output. Data e ora dell'ultimo aggiornamento dei metadati.

severity

string

Il valore di gravità dell'avviso. Il Centro avvisi imposterà questo campo al momento della creazione dell'avviso. Per impostazione predefinita, viene impostata una stringa vuota se non è stato possibile determinarla. I valori supportati per le azioni di aggiornamento in questo campo sono i seguenti:

  • ALTO
  • MEDIO
  • BASSO
etag

string

(Facoltativo) etag viene utilizzato per il controllo ottimistico della contemporaneità, in modo da impedire che gli aggiornamenti simultanei dei metadati di un avviso si sovrascrivano a vicenda. È vivamente consigliato che i sistemi utilizzino l'istruzione etag nel ciclo di lettura, modifica e scrittura per eseguire aggiornamenti dei metadati al fine di evitare le condizioni di gara: nella risposta viene restituito un etag che contiene i metadati dell'avviso e i sistemi devono inserire quell'etag nella richiesta per aggiornare i metadati dell'avviso per garantire che la modifica venga applicata alla stessa versione dei metadati dell'avviso.

Se nella chiamata non viene fornito alcun valore etag per aggiornare i metadati dell'avviso, i metadati dell'avviso esistenti vengono sovrascritti automaticamente.

Metodi

batchDelete

Esegue l'operazione di eliminazione batch sugli avvisi.

batchUndelete

Esegue un'operazione di annullamento dell'eliminazione batch sugli avvisi.

delete

Contrassegna l'avviso specificato per l'eliminazione.

get

Recupera l'avviso specificato.

getMetadata

Restituisce i metadati di un avviso.

list

Elenca gli avvisi.

undelete

Ripristina, o "ripristina l'eliminazione", un avviso contrassegnato per l'eliminazione negli ultimi 30 giorni.