REST Resource: alerts

संसाधन: चेतावनी

ग्राहक को प्रभावित करने वाली चेतावनी.

जेएसओएन के काेड में दिखाना
{
  "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 की पहचान
  • ऐप्लिकेशन बंद होना
data

object

ज़रूरी नहीं. इस चेतावनी से जुड़ा डेटा, जैसे कि google.apps.alertcenter.type.DeviceCompromised.

deleted

boolean

सिर्फ़ आउटपुट. True, अगर इस चेतावनी को मिटाने के लिए मार्क किया गया है.

metadata

object (AlertMetadata)

सिर्फ़ आउटपुट. इस चेतावनी से जुड़ा मेटाडेटा.

updateTime

string (Timestamp format)

सिर्फ़ आउटपुट. इस सूचना को पिछली बार कब अपडेट किया गया था.

etag

string

ज़रूरी नहीं. etag का इस्तेमाल, एक साथ होने वाली किसी चेतावनी को एक-दूसरे से ओवरराइट करने से रोकने के लिए किया जाता है. साथ ही, इस सेटिंग का इस्तेमाल, एक साथ कई काम करने के लिए किया जाता है. यह सुझाव दिया जाता है कि सिस्टम, रेस की शर्तों से बचने के लिए, चेतावनी को अपडेट करने के लिए, रीड-राइट-राइट साइकल में etag का इस्तेमाल करें. ऐसा करने पर, जवाब के तौर पर एक etag मिलता है. इसमें चेतावनी शामिल होती है. सिस्टम के पास, इसी सूचना को अपडेट करने के अनुरोध में शामिल करने की उम्मीद होती है, ताकि यह पक्का किया जा सके कि उसका बदलाव सूचना के एक ही वर्शन पर लागू हो.

अगर सूचना अपडेट करने के लिए कॉल में कोई etag नहीं दिया गया है, तो मौजूदा चेतावनी ओवरराइट हो जाएगी.

चेतावनी मेटाडेटा

चेतावनी का मेटाडेटा.

जेएसओएन के काेड में दिखाना
{
  "customerId": string,
  "alertId": string,
  "status": string,
  "assignee": string,
  "updateTime": string,
  "severity": string,
  "etag": string
}
फ़ील्ड
customerId

string

सिर्फ़ आउटपुट. ग्राहक के Google Workspace खाते का यूनीक आइडेंटिफ़ायर.

alertId

string

सिर्फ़ आउटपुट. चेतावनी का आइडेंटिफ़ायर.

status

string

चेतावनी की मौजूदा स्थिति. इस्तेमाल की जा सकने वाली वैल्यू ये हैं:

  • नोट नहीं किया गया
  • जारी है
  • बंद है
assignee

string

सूचना के लिए असाइन किए गए उपयोगकर्ता का ईमेल पता.

updateTime

string (Timestamp format)

सिर्फ़ आउटपुट. इस मेटाडेटा को पिछली बार कब अपडेट किया गया था.

severity

string

अलर्ट की गंभीरता का मान. अगर चेतावनी का पता नहीं चलता है, तो चेतावनी केंद्र इस फ़ील्ड को चेतावनी बनाए जाने के समय सेट कर देगा. साथ ही, यह डिफ़ॉल्ट रूप से खाली स्ट्रिंग पर सेट होगा. इस फ़ील्ड पर, अपडेट से जुड़ी कार्रवाइयों के लिए ये वैल्यू इस्तेमाल की जा सकती हैं:

  • ज़्यादा
  • सामान्य से बेहतर
  • कम
etag

string

ज़रूरी नहीं. etag का इस्तेमाल, एक साथ काम करने वाले, चेतावनी के मेटाडेटा को एक-दूसरे को ओवरराइट करने से रोकने के लिए किया जाता है. इस सुविधा की मदद से, एक साथ कई काम एक साथ मैनेज किए जा सकते हैं. यह विशेष रूप से सुझाव दिया जाता है कि सिस्टम, रेस की शर्तों से बचने के लिए मेटाडेटा अपडेट करने के लिए Read-Modified-write में etag का इस्तेमाल करें: चेतावनी मेटाडेटा वाली प्रतिक्रिया में एक etag दिया जाता है और सिस्टम से चेतावनी मेटाडेटा के समान वर्शन पर उनके बदलाव लागू करने के लिए अनुरोध में उस एटाग का इस्तेमाल करने की उम्मीद की जाती है.

अगर सूचना मेटाडेटा को अपडेट करने के लिए कॉल में कोई भी etag नहीं दिया गया है, तो मौजूदा चेतावनी मेटाडेटा ओवरराइट हो जाता है.

तरीके

batchDelete

चेतावनियों पर बैच मिटाने की कार्रवाई करता है.

batchUndelete

सूचनाओं को बैच से मिटाने की कार्रवाई करता है.

delete

मिटाई गई सूचना को मार्क करता है.

get

सूचना पाएं.

getMetadata

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

list

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

undelete

पिछले 30 दिनों के अंदर, मिटाई गई किसी चेतावनी को वापस लाया जाता है या उसे वापस लाया जाता है.