REST Resource: alerts

Kaynak: Uyarı

Müşteriyi etkileyen bir uyarı.

JSON gösterimi
{
  "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
}
Alanlar
customerId

string

Yalnızca çıkış. Müşterinin Google Workspace hesabının benzersiz tanımlayıcısı.

alertId

string

Yalnızca çıkış. Uyarının benzersiz tanımlayıcısı.

createTime

string (Timestamp format)

Yalnızca çıkış. Bu uyarının oluşturulduğu zaman.

startTime

string (Timestamp format)

Zorunlu. Bu uyarıya neden olan etkinliğin başlatıldığı veya algılandığı zaman.

endTime

string (Timestamp format)

İsteğe bağlı. Bu uyarının etkinleştirilmesine neden olan etkinliğin sona erdiği zaman. Belirtilmişse bitiş zamanı, başlangıç zamanından önce olmamalıdır. Sağlanmazsa devam eden bir uyarı olduğu anlamına gelir.

type

string

Zorunlu. Uyarının türü. Bu çıkış yalnızca uyarı oluşturulduktan sonra verilir. Mevcut uyarı türlerinin listesi için Google Workspace Uyarı türleri başlıklı makaleyi inceleyin.

source

string

Zorunlu. Uyarıyı bildiren sistem için benzersiz bir tanımlayıcı. Bu çıkış yalnızca uyarı oluşturulduktan sonra verilir.

Desteklenen kaynaklar aşağıdakilerden herhangi biridir:

  • Google İşlemleri
  • Mobil cihaz yönetimi
  • Gmail kimlik avı
  • Veri Kaybını Önleme
  • Alan genelinde alma
  • Devlet destekli saldırı
  • Google kimliği
  • Google Apps kesintisi
data

object

İsteğe bağlı. Bu uyarıyla ilişkilendirilen veriler (örneğin, google.apps.alertcenter.type.DeviceCompromised).

deleted

boolean

Yalnızca çıkış. Bu uyarı silinmek üzere işaretlenmişse True.

metadata

object (AlertMetadata)

Yalnızca çıkış. Bu uyarıyla ilişkili meta veriler.

updateTime

string (Timestamp format)

Yalnızca çıkış. Bu uyarının son güncellenme zamanı.

etag

string

İsteğe bağlı. etag, bir uyarının eş zamanlı güncellemelerinin birbirinin üzerine yazılmasını önlemek amacıyla iyimser eşzamanlılık kontrolü için kullanılır. Sistemlerin, yarış koşullarını önlemek amacıyla uyarı güncellemeleri gerçekleştirmek için okuma-değiştir-yazma döngüsünde etag öğesini kullanması önemle tavsiye edilir: Yanıtta uyarıları içeren bir etag döndürülür ve sistemlerin, değişikliklerinin uyarının aynı sürümüne uygulanmasını sağlamak için güncelleme uyarısına bu e etiketi yerleştirmesi beklenir.

Uyarıyı güncelleme çağrısında etag sağlanmazsa mevcut uyarının üzerine yazılmaz.

AlertMetadata

Uyarı meta verileri.

JSON gösterimi
{
  "customerId": string,
  "alertId": string,
  "status": string,
  "assignee": string,
  "updateTime": string,
  "severity": string,
  "etag": string
}
Alanlar
customerId

string

Yalnızca çıkış. Müşterinin Google Workspace hesabının benzersiz tanımlayıcısı.

alertId

string

Yalnızca çıkış. Uyarı tanımlayıcısı.

status

string

Uyarının mevcut durumu. Desteklenen değerler şunlardır:

  • NOT_STARTED
  • IN_PROGRESS
  • KAPALI
assignee

string

Uyarıya atanan kullanıcının e-posta adresi.

updateTime

string (Timestamp format)

Yalnızca çıkış. Bu meta verinin son güncellenme zamanı.

severity

string

Uyarının önem derecesi değeri. Uyarı Merkezi, bu alanı uyarı oluşturma zamanında ayarlar. Değer belirlenemediyse varsayılan olarak boş dize kullanılır. Bu alanda güncelleme işlemleri için desteklenen değerler şunlardır:

  • YÜKSEK
  • ORTA
  • DÜŞÜK
etag

string

İsteğe bağlı. etag, uyarı meta verilerinin eş zamanlı güncellemelerinin birbirinin üzerine yazmasını önlemek amacıyla iyimser eşzamanlılık kontrolü için kullanılır. Sistemlerin okuma-değiştirme-yazma döngüsünde etag öğesini kullanarak yarış koşullarını önlemesi önemle tavsiye edilir: Yanıtta uyarı meta verileri içeren bir etag döndürülür ve sistemlerin, uyarı meta verilerinin aynı sürümüne uygulanmasını sağlamak için uyarı meta verilerini güncelleme isteğine bu e etiketi yerleştirmesi beklenir.

Uyarı meta verilerini güncellemek için çağrıda etag sağlanmazsa mevcut uyarı meta verilerinin üzerine kör bir şekilde yazılır.

Yöntemler

batchDelete

Uyarılarda toplu silme işlemi gerçekleştirir.

batchUndelete

Uyarılarda toplu silme geri alma işlemini gerçekleştirir.

delete

Belirtilen uyarıyı silinmek üzere işaretler.

get

Belirtilen uyarıyı alır.

getMetadata

Bir uyarının meta verilerini döndürür.

list

Uyarıları listeler.

undelete

Son 30 gün içinde silinmek üzere işaretlenmiş bir uyarıyı geri yükler veya "silme işlemini geri alır".