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 Operations
  • मोबाइल डिवाइस मैनेजमेंट
  • Gmail फ़िशिंग
  • डेटा लीक होने की रोकथाम
  • पूरे डोमेन से डेटा निकालना
  • सरकार प्रायोजित हमला
  • Google की पहचान
  • ऐप्लिकेशन कुछ समय के लिए उपलब्ध न होना
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 नहीं दिया जाता है, तो मौजूदा सूचना का मेटाडेटा बिना किसी जानकारी के ओवरराइट हो जाता है.

तरीके

batchDelete

 सूचनाओं को एक साथ मिटाने की सुविधा चालू करता है.

batchUndelete

 चेतावनियों को मिटाए गए बैच को वापस लाने का काम करता है.

delete

 चुनी गई चेतावनी को मिटाने के लिए मार्क करता है.

get

 तय की गई सूचना मिलती है.

getMetadata

 किसी सूचना का मेटाडेटा दिखाता है.

list

 अलर्ट की सूची दिखाता है.

undelete

 पिछले 30 दिनों में मिटाने के लिए मार्क की गई चेतावनी को वापस लाता है या "मिटाया नहीं गया" के तौर पर सेट करता है.