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
  • הפסקה זמנית ב-Apps
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

הסטטוס הנוכחי של ההתראה. אלה הערכים הנתמכים:

  • NOT_STARTED
  • התקדמות
  • סגור
assignee

string

כתובת האימייל של המשתמש שהוקצה להתראה.
updateTime

string (Timestamp format)

פלט בלבד. שעת העדכון האחרון של המטא-נתונים.
severity

string

ערך החומרה של ההתראה. במרכז ההתראות יוגדר השדה הזה בזמן יצירת ההתראה, כברירת מחדל, מחרוזת ריקה לא תיקבע. הערכים הנתמכים לפעולות עדכון בשדה הזה הם:

  • גבוהה
  • בינוני
  • נמוך
etag

string

אופציונלי. המוצר etag משמש לשליטה בו-זמנית בגישה אופטית כדי לעזור במניעת עדכונים בו-זמנית של מטא-נתונים של התראות, ולהחליף זה את זה. מומלץ מאוד שמערכות ישתמשו ב-etag במחזור הקריאה-שינוי-כתיבה כדי לבצע עדכוני מטא-נתונים כדי להימנע מתנאי תחרות: etag יוחזר בתגובה שמכיל מטא-נתונים של התראה, והמערכות צפויות להציב את ה-etag הזה בבקשה לעדכון מטא-נתונים של התראה כדי להבטיח שהשינוי שלהם יחול על אותה גרסה של המטא-נתונים של ההתראה.

אם לא מסופק מספר etag בשיחה כדי לעדכן מטא-נתונים של התראה, המטא-נתונים הקיימים של ההתראה יוחלפו בצורה עיוורת.

שיטות

batchDelete

 מבצע פעולת מחיקה בכמות גדולה בהתראות.

batchUndelete

 מבצע פעולת ביטול מחיקה בכמות גדולה בהתראות.

delete

 סימון ההתראה שצוינה למחיקה.

get

 מתקבלת ההתראה שצוינה.

getMetadata

 מחזירה את המטא-נתונים של ההתראה.

list

 מפרט את ההתראות.

undelete

 משחזרת או מבטלת את המחיקה של התראה שסומנה למחיקה ב-30 הימים האחרונים.