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

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ıya neden olan etkinliğin sona erdiği zaman. Sağlanmışsa bitiş zamanı başlangıç zamanından önce olmamalıdır. Bu uyarı sağlanmazsa devam eden bir uyarı gösterilir.

type

string

Zorunlu. Uyarının türü. Bu, yalnızca uyarı oluşturulduktan sonra gösterilir. Kullanılabilir uyarı türlerinin listesi için Google Workspace Uyarı türleri başlıklı makaleyi inceleyin.

source

string

Zorunlu. Uyarıyı bildiren sistemin benzersiz tanımlayıcısı. Bu, yalnızca uyarı oluşturulduktan sonra gösterilir.

Desteklenen kaynaklar şunlardır:

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

object

İsteğe bağlı. Bu uyarıyla ilişkili veriler (ör. google.apps.alertcenter.type.DeviceCompromised).

deleted

boolean

Yalnızca çıkış. Bu uyarı silinmek üzere işaretlendiyse 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 aynı anda güncellenmesinin birbirinin üzerine yazılmasını önlemeye yardımcı olmak için iyimser eşzamanlılık kontrolü için kullanılır. Sistemlerin, yarış koşullarını önlemek amacıyla uyarı güncellemeleri yapmak için okuma-değiştirme yazma döngüsündeki etag özelliğini kullanması önemle tavsiye edilir: Yanıt içeren yanıtta bir etag döndürülür ve sistemlerin, uyarıların aynı uyarı sürümüne uygulanması için uyarı güncelleme isteğine bu etiketi eklemesi beklenir.

Uyarıyı güncelleme çağrısında etag sağlanmazsa mevcut uyarının kör şekilde üzerine yazılır.

UyarıMeta Verileri

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. Uyarı Merkezi, bu alanı uyarı oluşturulurken oluşturur. Belirlenemediği zaman ise varsayılan olarak boş bir dize verilir. Bu alandaki 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 yazılmasını önlemenin bir yolu olarak iyimser eşzamanlılık kontrolü için kullanılır. Sistemlerin, rekabet koşullarını önlemek amacıyla meta veri güncellemelerini gerçekleştirmek için okuma-değiştirme yazma döngüsündeki etag kullanımından yararlanması önemle tavsiye edilir: Yanıtta meta verilerin bulunduğu yanıtta bir etag döndürülür ve sistemin, değişikliklerinin uyarı meta verilerinin aynı sürümüne uygulanmasını sağlamak üzere uyarı meta verilerini güncelleme isteğine dahil etmesi beklenir.

Uyarı meta verilerinin güncellenmesi için çağrıda etag sağlanmazsa mevcut uyarı meta verilerinin körü körüne yazılır.

Yöntemler

batchDelete

Uyarılar üzerinde toplu silme işlemi gerçekleştirir.

batchUndelete

Uyarılar üzerinde toplu silme işlemini geri alma işlemi 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 "geri alır".