REST Resource: alerts

Kaynak: Uyarı

Bir müşteriyi etkileyen 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ış. Alarmı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ıya neden olan etkinliğin etkinliğini durdurduğu zaman. Belirtilen bitiş zamanı, başlangıç zamanından önce olmamalıdır. Bu değer sağlanmazsa devam eden bir uyarı olduğunu gösterir.

type

string

Zorunlu. Uyarının türü. Bu, yalnızca uyarı oluşturulduktan sonra yayınlanır. 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ıdır. Bu, yalnızca uyarı oluşturulduktan sonra yayınlanır.

Desteklenen kaynaklar aşağıdakilerden herhangi biri olabilir:

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

object

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

deleted

boolean

Yalnızca çıkış. True bu uyarı silinmek üzere işaretlendiyse.

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 yazmasını önlemek için iyimser eşzamanlılık kontrolü için kullanılır. Sistemlerin, yarış koşullarını önlemek için uyarı güncellemeleri yapmak üzere okuma-değiştirme-yazma döngüsünde etag kullanması önemle tavsiye edilir: Yanıtta, uyarıları içeren bir etag döndürülür ve sistemlerin, değişikliğin uyarının aynı sürümüne uygulanmasını sağlamak için bu etag'i uyarıyı güncelleme isteğine koyması beklenir.

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

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 verilerin son güncellenme zamanı.

severity

string

Uyarının önem derecesi değeri. Uyarı Merkezi, bu alanı uyarı oluşturulurken ayarlar. Belirlenemediği durumlarda varsayılan olarak boş bir dize olur. 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, bir uyarı meta verisinin eşzamanlı güncellemelerinin birbirinin üzerine yazmasını önlemek için iyimser eşzamanlılık kontrolü için kullanılır. Sistemlerin, yarış koşullarını önlemek için meta veri güncellemeleri yapmak üzere okuma-değiştirme-yazma döngüsünde etag kullanması önemle tavsiye edilir: Yanıtta, uyarı meta verilerini içeren bir etag döndürülür ve sistemlerin, değişikliklerinin uyarı meta verilerinin aynı sürümüne uygulanmasını sağlamak için bu etag'i uyarı meta verilerini güncelleme isteğine koyması beklenir.

Uyarı meta verilerini güncelleme çağrısında etag sağlanmazsa mevcut uyarı meta verilerinin üzerine rastgele yazılır.

Yöntemler

batchDelete

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

batchUndelete

Uyarılarda toplu silme işlemini 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 "silinmesini geri alır".