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

ضروری. یک شناسه منحصر به فرد برای سیستمی که هشدار را گزارش کرده است. این خروجی تنها پس از ایجاد هشدار است.

منابع پشتیبانی شده یکی از موارد زیر است:

  • عملیات گوگل
  • مدیریت دستگاه موبایل
  • فیشینگ جیمیل
  • پیشگیری از از دست دادن داده ها
  • خروجی گسترده دامنه
  • حمله با حمایت دولت
  • هویت گوگل
  • قطع شدن برنامه ها
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
  • در حال پیش رفت
  • بسته شده
assignee

string

آدرس ایمیل کاربر اختصاص داده شده به هشدار.

updateTime

string ( Timestamp format)

فقط خروجی زمانی که این ابرداده آخرین بار به روز شد.

severity

string

ارزش شدت هشدار. مرکز هشدار این فیلد را در زمان ایجاد هشدار تنظیم می‌کند، زمانی که نمی‌توان آن را تعیین کرد، به‌طور پیش‌فرض روی یک رشته خالی تنظیم می‌کند. مقادیر پشتیبانی شده برای اقدامات به روز رسانی در این فیلد به شرح زیر است:

  • بالا
  • متوسط
  • کم
etag

string

اختیاری. etag برای کنترل همزمانی خوشبینانه به عنوان راهی برای کمک به جلوگیری از به‌روزرسانی همزمان ابرداده هشدار از رونویسی یکدیگر استفاده می‌شود. قویاً پیشنهاد می‌شود که سیستم‌ها از این etag در چرخه خواندن-تغییر-نوشتن برای انجام به‌روزرسانی‌های ابرداده استفاده کنند تا از شرایط مسابقه اجتناب کنند: یک etag در پاسخی که حاوی فراداده هشدار است برگردانده می‌شود و انتظار می‌رود سیستم‌ها آن تگ را قرار دهند. در درخواست به‌روزرسانی فراداده هشدار برای اطمینان از اینکه تغییر آنها در همان نسخه ابرداده هشدار اعمال می‌شود.

اگر هیچ etag در تماس برای به‌روزرسانی فراداده هشدار ارائه نشده باشد، فراداده هشدار موجود به‌صورت کورکورانه بازنویسی می‌شود.

مواد و روش ها

batchDelete

 عملیات حذف دسته ای در هشدارها را انجام می دهد.

batchUndelete

 عملیات حذف دسته ای را در هشدارها انجام می دهد.

delete

 هشدار مشخص شده را برای حذف علامت گذاری می کند.

get

 هشدار مشخص شده را دریافت می کند.

getMetadata

 فراداده یک هشدار را برمی گرداند.

list

 هشدارها را فهرست می کند.

undelete

 هشداری را که در 30 روز گذشته برای حذف علامت‌گذاری شده بود، بازیابی می‌کند یا «حذف می‌کند».