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 משמשת לבקרה אופטימית בו-זמניות (concurrency) כדי למנוע מצב שבו עדכונים להתראות בו-זמנית יחליפו אחד את השני. מומלץ מאוד שמערכות ישתמשו ב-etag במחזור read-modify-write כדי לבצע עדכוני התראות כדי להימנע ממרוץ תהליכים: בתגובה מוחזר 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

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

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

string

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

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

שיטות

batchDelete

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

batchUndelete

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

delete

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

get

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

getMetadata

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

list

 ליצירת רשימה של ההתראות.

undelete

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