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. Waktu peristiwa yang menyebabkan notifikasi ini dimulai atau terdeteksi.

endTime

string (Timestamp format)

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

type

string

Wajib. Jenis notifikasi. 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 ini:

  • Google Operations
  • Pengelolaan perangkat seluler
  • Phishing Gmail
  • Pencegahan Kebocoran Data
  • 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 pemberitahuan ini.

updateTime

string (Timestamp format)

Hanya output. Waktu notifikasi ini terakhir diperbarui.

etag

string

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

Jika tidak ada etag yang disediakan dalam panggilan untuk mengupdate pemberitahuan, pemberitahuan yang ada akan ditimpa secara acak.

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

updateTime

string (Timestamp format)

Hanya output. Waktu metadata ini terakhir diperbarui.

severity

string

Nilai tingkat keseriusan notifikasi. Pusat Notifikasi akan menetapkan kolom ini pada waktu pembuatan pemberitahuan. Setelan defaultnya adalah string kosong jika 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 update simultan metadata pemberitahuan agar tidak menimpa satu sama lain. Sangat disarankan agar 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 untuk 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 disediakan dalam panggilan untuk memperbarui metadata pemberitahuan, metadata pemberitahuan yang ada akan ditimpa secara acak.

Metode

batchDelete

Melakukan operasi penghapusan batch pada pemberitahuan.

batchUndelete

Melakukan operasi pembatalan penghapusan batch pada pemberitahuan.

delete

Menandai notifikasi yang ditentukan untuk dihapus.

get

Mendapatkan notifikasi yang ditentukan.

getMetadata

Menampilkan metadata pemberitahuan.

list

Mencantumkan pemberitahuan.

undelete

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