REST Resource: alerts

Resource: Notifikasi

Notifikasi yang memengaruhi pelanggan.

Representasi 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
}
Kolom
customerId

string

Hanya output. ID unik akun Google Workspace pelanggan.

alertId

string

Hanya output. ID unik untuk pemberitahuan.

createTime

string (Timestamp format)

Hanya output. Waktu pembuatan pemberitahuan ini.

startTime

string (Timestamp format)

Wajib. Waktu peristiwa yang menyebabkan pemberitahuan ini dimulai atau terdeteksi.

endTime

string (Timestamp format)

Opsional. Waktu peristiwa yang menyebabkan pemberitahuan ini berhenti aktif. Jika diberikan, waktu berakhir tidak boleh lebih awal dari waktu mulai. Jika tidak diberikan, ini menunjukkan pemberitahuan yang sedang berlangsung.

type

string

Wajib. Jenis pemberitahuan. Ini adalah output hanya setelah pemberitahuan dibuat. Untuk mengetahui daftar jenis notifikasi yang tersedia, lihat Jenis Notifikasi Google Workspace.

source

string

Wajib. ID unik untuk sistem yang melaporkan pemberitahuan. Ini adalah output hanya setelah pemberitahuan dibuat.

Sumber yang didukung adalah salah satu dari berikut:

  • Google Operations
  • Pengelolaan perangkat seluler
  • Phishing Gmail
  • Pencegahan Kebocoran Data
  • Pengeksporan seluruh domain
  • Serangan yang didukung pemerintah
  • Identitas Google
  • Pemadaman aplikasi
data

object

Opsional. Data yang terkait dengan pemberitahuan ini, misalnya google.apps.alertcenter.type.DeviceCompromised.

deleted

boolean

Hanya output. True jika pemberitahuan ini ditandai untuk dihapus.

metadata

object (AlertMetadata)

Hanya output. Metadata yang terkait dengan pemberitahuan ini.

updateTime

string (Timestamp format)

Hanya output. Waktu notifikasi ini terakhir diperbarui.

etag

string

Opsional. etag digunakan untuk kontrol konkurensi optimis sebagai cara untuk membantu mencegah pembaruan pemberitahuan secara bersamaan agar tidak menimpa satu sama lain. Sebaiknya sistem menggunakan etag dalam siklus read-modify-write untuk melakukan pembaruan pemberitahuan guna menghindari kondisi race: etag ditampilkan dalam respons yang berisi pemberitahuan, dan sistem diharapkan menempatkan etag tersebut dalam permintaan untuk memperbarui pemberitahuan guna memastikan bahwa perubahannya akan diterapkan ke versi pemberitahuan yang sama.

Jika tidak ada etag yang diberikan dalam panggilan untuk memperbarui pemberitahuan, pemberitahuan yang ada akan ditimpa secara membabi buta.

AlertMetadata

Metadata pemberitahuan.

Representasi JSON
{
  "customerId": string,
  "alertId": string,
  "status": string,
  "assignee": string,
  "updateTime": string,
  "severity": string,
  "etag": string
}
Kolom
customerId

string

Hanya output. ID unik akun Google Workspace pelanggan.

alertId

string

Hanya output. ID pemberitahuan.

status

string

Status notifikasi saat ini. Nilai yang didukung adalah sebagai berikut:

  • NOT_STARTED
  • IN_PROGRESS
  • TERTUTUP
assignee

string

Alamat email pengguna yang ditetapkan ke pemberitahuan.

updateTime

string (Timestamp format)

Hanya output. Waktu metadata ini terakhir diperbarui.

severity

string

Nilai tingkat keparahan pemberitahuan. Pusat Notifikasi akan menetapkan kolom ini pada waktu pembuatan notifikasi, dengan default string kosong jika tidak dapat ditentukan. Nilai yang didukung untuk tindakan pembaruan di kolom ini adalah sebagai berikut:

  • TINGGI
  • SEDANG
  • RENDAH
etag

string

Opsional. etag digunakan untuk kontrol konkurensi optimis sebagai cara untuk membantu mencegah pembaruan metadata pemberitahuan secara bersamaan agar tidak menimpa satu sama lain. Sebaiknya sistem menggunakan etag dalam siklus read-modify-write untuk melakukan pembaruan metadata guna menghindari kondisi race: etag ditampilkan dalam respons yang berisi metadata pemberitahuan, dan sistem diharapkan menempatkan etag tersebut dalam permintaan untuk memperbarui metadata pemberitahuan guna memastikan bahwa perubahannya akan diterapkan ke versi metadata pemberitahuan yang sama.

Jika tidak ada etag yang diberikan dalam panggilan untuk memperbarui metadata pemberitahuan, metadata pemberitahuan yang ada akan ditimpa secara membabi buta.

Metode

batchDelete

Melakukan operasi penghapusan batch pada notifikasi.

batchUndelete

Melakukan operasi pembatalan penghapusan batch pada notifikasi.

delete

Menandai notifikasi yang ditentukan untuk dihapus.

get

Mendapatkan pemberitahuan yang ditentukan.

getMetadata

Menampilkan metadata pemberitahuan.

list

Mencantumkan pemberitahuan.

undelete

Memulihkan, atau "membatalkan penghapusan", notifikasi yang ditandai untuk dihapus dalam 30 hari terakhir.