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 दिनों के अंदर मिटाने के लिए मार्क किया गया था.