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 นั้นในคําขออัปเดตการแจ้งเตือนเพื่อให้การเปลี่ยนแปลงมีผลในการแจ้งเตือนเวอร์ชันเดียวกัน

หากไม่ได้ระบุ etag ในการเรียกใช้การแจ้งเตือนให้อัปเดต ระบบจะเขียนทับการแจ้งเตือนที่มีอยู่แบบสุ่ม

ข้อมูลเมตาของการแจ้งเตือน

ข้อมูลเมตาของการแจ้งเตือน

การแสดง JSON
{
  "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 จะใช้สําหรับการควบคุมการเกิดขึ้นพร้อมกันแบบเพิ่มประสิทธิภาพเพื่อป้องกันไม่ให้การอัปเดตข้อมูลเมตาของการแจ้งเตือนพร้อมกันถูกเขียนทับ ขอแนะนําอย่างยิ่งให้ระบบใช้ประโยชน์จาก etag ในวงจร Read-modify-Write เพื่ออัปเดตข้อมูลเมตาเพื่อหลีกเลี่ยงเงื่อนไขการแข่งขัน: ระบบจะแสดงผล etag ในการตอบกลับที่มีข้อมูลเมตาการแจ้งเตือน และระบบควรใส่ Etag นั้นในคําขอเพื่ออัปเดตข้อมูลเมตาการแจ้งเตือน เพื่อให้ระบบนําการเปลี่ยนแปลงไปใช้กับข้อมูลเมตาการแจ้งเตือนเวอร์ชันเดียวกัน

หากไม่ได้ระบุ etag ในสายเพื่ออัปเดตข้อมูลเมตาของการแจ้งเตือน ระบบจะเขียนทับข้อมูลเมตาการแจ้งเตือนที่มีอยู่แบบสุ่ม

วิธีการ

batchDelete

ดําเนินการลบเป็นกลุ่มกับการแจ้งเตือน

batchUndelete

ดําเนินการยกเลิกการลบเป็นกลุ่มในการแจ้งเตือน

delete

ทําเครื่องหมายการแจ้งเตือนที่ต้องการลบ

get

รับการแจ้งเตือนที่ระบุ

getMetadata

แสดงผลข้อมูลเมตาของการแจ้งเตือน

list

แสดงรายการการแจ้งเตือน

undelete

กู้คืนหรือ "ยกเลิกการลบ" การแจ้งเตือนที่ระบบทําเครื่องหมายเพื่อลบภายใน 30 วันที่ผ่านมา