REST Resource: alerts

المورد: تنبيه

تنبيه يؤثر على العميل.

تمثيل 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
}
الحقول
customerId

string

الإخراج فقط. المعرّف الفريد لحساب العميل على Google Workspace

alertId

string

الإخراج فقط. المعرّف الفريد للتنبيه.

createTime

string (Timestamp format)

الإخراج فقط. وقت إنشاء هذا التنبيه.

startTime

string (Timestamp format)

مطلوبة. وقت بدء الحدث الذي تم رصده أو رصده من خلال هذا الحدث.

endTime

string (Timestamp format)

اختياريّ. الوقت الذي توقف فيه الحدث الذي تسبب في هذا التنبيه في العمل. في حال تقديمه، يجب ألا يكون وقت الانتهاء قبل وقت البدء. إذا لم يتم تقديمها، فإنها تشير إلى تنبيه مستمر.

type

string

مطلوبة. نوع التنبيه. ولا يتم هذا الإخراج إلا بعد إنشاء التنبيه. للحصول على قائمة بأنواع التنبيهات المتاحة، يُرجى الاطِّلاع على أنواع تنبيهات Google Workspace.

source

string

مطلوبة. معرّف فريد للنظام الذي أبلغ عن التنبيه. ولا يتم هذا الإخراج إلا بعد إنشاء التنبيه.

المصادر المتوافقة هي أي مما يلي:

  • عمليات Google
  • إدارة الأجهزة الجوّالة
  • التصيّد الاحتيالي لخدمة Gmail
  • منع فقدان البيانات
  • التصدير على مستوى النطاق
  • هجوم برعاية الدولة
  • هوية Google
  • انقطاع الخدمة عن التطبيقات
data

object

اختياريّ. البيانات المرتبطة بهذا التنبيه، على سبيل المثال google.apps.alertcenter.type.DeviceCompromised

deleted

boolean

الإخراج فقط. True إذا تم وضع علامة على هذا التنبيه للحذف.

metadata

object (AlertMetadata)

الإخراج فقط. البيانات الوصفية المرتبطة بهذا التنبيه.

updateTime

string (Timestamp format)

الإخراج فقط. وقت آخر تعديل للتنبيه.

etag

string

اختياريّ. يتم استخدام etag للتحكّم المتزامن في التزامن كوسيلة للمساعدة في منع التحديثات المتزامنة للتنبيه من استبدال بعضها البعض. نقترح بشدة أن تستخدم الأنظمة etag في دورة القراءة-تعديل-تعديل لتعديل التنبيه لتجنب شروط السباق: يتم عرض etag في الاستجابة التي تحتوي على تنبيهات، ويُتوقع من الأنظمة أن تضع علامة etag في طلب تحديث التنبيه لضمان تطبيق التغيير على الإصدار نفسه من التنبيه.

إذا لم يتم تقديم etag في المكالمة لتعديل التنبيه، سيتم استبدال التنبيه الحالي بعمى.

بيانات وصفية للتنبيه

البيانات الوصفية للتنبيه.

تمثيل JSON
{
  "customerId": string,
  "alertId": string,
  "status": string,
  "assignee": string,
  "updateTime": string,
  "severity": string,
  "etag": string
}
الحقول
customerId

string

الإخراج فقط. المعرّف الفريد لحساب العميل على Google Workspace

alertId

string

الإخراج فقط. معرّف التنبيه.

status

string

الحالة الحالية للتنبيه. القيم المسموح بها هي ما يلي:

  • لم يتم البدء
  • IN_PROGRESS
  • مغلق
assignee

string

عنوان البريد الإلكتروني للمستخدم الذي تم تعيينه للتنبيه.

updateTime

string (Timestamp format)

الإخراج فقط. وقت آخر تحديث لهذه البيانات الوصفية.

severity

string

قيمة درجة خطورة التنبيه. سيعين "مركز التنبيه" هذا الحقل في وقت إنشاء التنبيه، يكون الإعداد التلقائي هو سلسلة فارغة عندما يتعذّر تحديده. في ما يلي القيم المسموح بها لإجراءات التحديث في هذا الحقل:

  • درجة التزام عالية
  • متوسط
  • درجة التزام منخفضة
etag

string

اختياريّ. يتم استخدام etag للتحكّم المتزامن في التزامن كطريقة للمساعدة في منع التحديثات المتزامنة للبيانات الوصفية للتنبيهات من استبدال بعضها البعض. نقترح بشدة أن تستخدم الأنظمة etag في دورة القراءة-تعديل-تعديل لإجراء تعديلات البيانات الوصفية لتجنب شروط السباق: يتم عرض etag في الاستجابة التي تحتوي على بيانات وصفية للتنبيه، ويُتوقع من الأنظمة وضع علامة etag في طلب تحديث البيانات الوصفية للتنبيه لضمان تطبيق التغيير على الإصدار نفسه من البيانات الوصفية للتنبيه.

إذا لم يتم تقديم etag في المكالمة لتعديل البيانات الوصفية للتنبيه، سيتم استبدال البيانات الوصفية الحالية للتنبيه بشكل عشوائي.

الطُرق

batchDelete

إجراء عملية حذف مجمّع للتنبيهات.

batchUndelete

تنفيذ عملية إلغاء الحذف المجمّع للتنبيهات.

delete

وضع علامة على التنبيه المُحدَّد لحذفه.

get

الحصول على التنبيه المحدد.

getMetadata

لعرض البيانات الوصفية لتنبيه.

list

يسرد التنبيهات.

undelete

استعادة التنبيه الذي تم وضع علامة عليه لحذفه خلال الثلاثين يومًا الماضية، أو "إلغاء حذفه".