REST Resource: alerts

Resource: Pemberitahuan

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 notifikasi.

createTime

string (Timestamp format)

Hanya output. Waktu notifikasi ini dibuat.

startTime

string (Timestamp format)

Wajib diisi. Waktu saat peristiwa yang menyebabkan notifikasi ini dimulai atau terdeteksi.

endTime

string (Timestamp format)

Opsional. Waktu saat peristiwa yang memicu notifikasi 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 diisi. Jenis notifikasi. Notifikasi ini hanya output setelah pemberitahuan dibuat. Untuk daftar jenis notifikasi yang tersedia, lihat Jenis notifikasi Google Workspace.

source

string

Wajib diisi. ID unik untuk sistem yang melaporkan notifikasi. Notifikasi ini hanya output setelah pemberitahuan dibuat.

Sumber yang didukung adalah salah satu dari berikut ini:

  • Google Operations
  • Pengelolaan perangkat seluler
  • Phishing Gmail
  • Data Loss Prevention
  • Pengeksporan seluruh domain
  • Serangan yang disponsori negara bagian
  • Identitas Google
  • Pemadaman aplikasi
data

object

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

deleted

boolean

Hanya output. True jika notifikasi ini ditandai untuk dihapus.

metadata

object (AlertMetadata)

Hanya output. Metadata yang terkait dengan notifikasi ini.

updateTime

string (Timestamp format)

Hanya output. Waktu notifikasi ini terakhir diperbarui.

etag

string

Opsional. etag digunakan untuk kontrol serentak optimis sebagai cara untuk mencegah update simultan pemberitahuan menimpa satu sama lain. Sebaiknya sistem menggunakan etag dalam siklus baca-ubah-tulis untuk melakukan update notifikasi guna menghindari kondisi race: etag ditampilkan dalam respons yang berisi notifikasi, dan sistem diharapkan menempatkan etag tersebut dalam permintaan untuk mengupdate notifikasi guna memastikan bahwa perubahannya akan diterapkan ke versi notifikasi yang sama.

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

PemberitahuanPeringatan

Metadata notifikasi.

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 notifikasi.

status

string

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

  • TIDAK_DIMULAI
  • DALAM PROSES
  • TERTUTUP
assignee

string

Alamat email pengguna yang ditetapkan untuk notifikasi.

updateTime

string (Timestamp format)

Hanya output. Waktu metadata ini terakhir diperbarui.

severity

string

Nilai tingkat keseriusan notifikasi. Pusat Notifikasi akan menyetel kolom ini pada waktu pembuatan pemberitahuan, secara default menggunakan string kosong ketika tidak dapat ditentukan. Nilai yang didukung untuk tindakan update di kolom ini adalah sebagai berikut:

  • TINGGI
  • SEDANG
  • RENDAH
etag

string

Opsional. etag digunakan untuk kontrol serentak optimis sebagai cara untuk membantu mencegah pembaruan metadata pemberitahuan secara simultan agar tidak menimpa satu sama lain. Sebaiknya sistem menggunakan etag dalam siklus baca-ubah-tulis untuk melakukan pembaruan metadata guna menghindari kondisi race: etag ditampilkan dalam respons yang berisi metadata pemberitahuan, dan sistem diharapkan menempatkan tag tersebut dalam permintaan untuk memperbarui metadata pemberitahuan guna memastikan perubahannya akan diterapkan ke versi metadata notifikasi yang sama.

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

Metode

batchDelete

Melakukan operasi penghapusan batch pada pemberitahuan.

batchUndelete

Melakukan operasi pembatalan penghapusan batch pada notifikasi.

delete

Menandai pemberitahuan yang ditentukan untuk dihapus.

get

Mendapatkan pemberitahuan yang ditentukan.

getMetadata

Menampilkan metadata notifikasi.

list

Mencantumkan pemberitahuan.

undelete

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