REST Resource: alerts

Risorsa: avviso

Un avviso che interessa 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 è stato avviato o rilevato l'evento che ha causato l'avviso.

endTime

string (Timestamp format)

(Facoltativo) L'ora in cui l'evento che ha causato l'avviso non è più attivo. Se specificato, l'ora di fine non deve essere antecedente all'ora di inizio. Se non viene fornito, significa che è presente un avviso in corso.

type

string

Obbligatorio. Il tipo di avviso. L'output 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. L'output viene generato solo dopo la creazione dell'avviso.

Le origini supportate sono:

  • Google Operations
  • Gestione dei dispositivi mobili
  • Phishing Gmail
  • Data Loss Prevention
  • Takeout a livello di dominio
  • Attacco sponsorizzato dallo stato
  • Identità Google
  • Interruzione di Apps
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 all'avviso.

updateTime

string (Timestamp format)

Solo output. L'ultimo aggiornamento dell'avviso.

etag

string

(Facoltativo) etag viene utilizzato per un controllo ottimistico della contemporaneità come metodo per impedire la sovrascrittura degli aggiornamenti simultanei di un avviso. Consigliamo vivamente ai sistemi di utilizzare etag nel ciclo di lettura, modifica e scrittura per eseguire gli aggiornamenti degli avvisi ed evitare condizioni di gara: viene restituito un etag nella risposta che contiene avvisi e i sistemi devono inserire l'etichetta nella richiesta di aggiornamento dell'avviso per assicurarsi che la modifica venga applicata alla stessa versione dell'avviso.

Se nella chiamata non viene fornito alcun avviso etag, l'avviso esistente viene sovrascritto ciecamente.

Metadati avviso

I metadati dell'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:

  • NON_INIZIATO
  • IN_PROGRESS
  • CHIUSO
assignee

string

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

updateTime

string (Timestamp format)

Solo output. L'ultimo aggiornamento dei metadati.

severity

string

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

  • ALTO
  • MEDIO
  • BASSO
etag

string

(Facoltativo) etag viene utilizzato per un controllo ottimistico della contemporaneità come metodo per impedire la sovrascrittura degli aggiornamenti simultanei di un metadati di avviso. Consigliamo vivamente ai sistemi di utilizzare etag nel ciclo di lettura, modifica e scrittura per eseguire gli aggiornamenti dei metadati ed evitare così le condizioni della gara: nella risposta viene restituito un etag che contiene i metadati dell'avviso e i sistemi sono tenuti a inserire questo tag nella richiesta di aggiornamento dei metadati dell'avviso per assicurarsi che la modifica venga applicata alla stessa versione dei metadati dell'avviso.

Se nella chiamata non viene fornito alcun dato etag, i metadati dell'avviso esistenti vengono sovrascritti ciecamente.

Metodi

batchDelete

Esegue un'operazione di eliminazione in batch sugli avvisi.

batchUndelete

Esegue un'operazione di annullamento dell'eliminazione collettiva per gli avvisi.

delete

Contrassegna l'avviso specificato per l'eliminazione.

get

Visualizza l'avviso specificato.

getMetadata

Restituisce i metadati di un avviso.

list

Elenca gli avvisi.

undelete

Ripristina o "annulla": un avviso contrassegnato per l'eliminazione negli ultimi 30 giorni.