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 Identity
  • انقطاع الخدمة عن التطبيقات
data

object

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

boolean

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

object (AlertMetadata)

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

string (Timestamp format)

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

string

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

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

AlertMetadata

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

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

string

النتائج فقط. المعرّف الفريد لحساب Google Workspace للعميل
alertId

string

النتائج فقط. معرِّف التنبيه.
status

string

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

  • NOT_STARTED
  • IN_PROGRESS
  • مغلق
assignee

string

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

string (Timestamp format)

النتائج فقط. تاريخ آخر تعديل لهذه البيانات الوصفية
severity

string

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

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

string

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

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

الطُرق

batchDelete

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

batchUndelete

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

delete

 يحدد التنبيه المحدد للحذف.

get

 تلقّي التنبيه المحدَّد

getMetadata

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

list

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

undelete

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