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: סוגי התראות ב-Google Workspace.
source

string

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

המקורות הנתמכים הם:

  • Google Operations
  • ניהול מכשירים ניידים
  • פישינג ב-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 בקריאה לעדכון ההתראה, ההתראה הקיימת תוחלף באופן עיוור.

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 הזה לבקשה לעדכון המטא-נתונים של ההתראות כדי להבטיח שהשינוי שלהן יחול על אותה גרסה של המטא-נתונים של ההתראות.

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

Methods

batchDelete

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

batchUndelete

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

delete

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

get

 אחזור ההתראה שצוינה.

getMetadata

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

list

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

undelete

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