REST Resource: alerts

Tài nguyên: Cảnh báo

Cảnh báo ảnh hưởng đến một khách hàng.

Biểu diễn dưới dạng 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
}
Trường
customerId

string

Chỉ có đầu ra. Mã nhận dạng duy nhất của tài khoản Google Workspace của khách hàng.
alertId

string

Chỉ có đầu ra. Giá trị nhận dạng duy nhất của cảnh báo.
createTime

string (Timestamp format)

Chỉ có đầu ra. Thời điểm thông báo này được tạo.
startTime

string (Timestamp format)

Bắt buộc. Thời điểm bắt đầu hoặc phát hiện sự kiện gây ra cảnh báo này.
endTime

string (Timestamp format)

Không bắt buộc. Thời gian sự kiện gây ra cảnh báo này ngừng hoạt động. Nếu được cung cấp, thời gian kết thúc không được sớm hơn thời gian bắt đầu. Nếu dòng chữ không được cung cấp, điều này cho biết một cảnh báo đang diễn ra.
type

string

Bắt buộc. Loại cảnh báo. Đây chỉ là kết quả đầu ra sau khi cảnh báo được tạo. Để biết danh sách các loại thông báo hiện có, hãy xem bài viết Các loại thông báo của Google Workspace.
source

string

Bắt buộc. Giá trị nhận dạng duy nhất của hệ thống báo cáo cảnh báo. Đây chỉ là kết quả đầu ra sau khi cảnh báo được tạo.

Các nguồn được hỗ trợ là:

  • Hoạt động của Google
  • Quản lý thiết bị di động
  • Lừa đảo trong Gmail
  • Ngăn chặn mất dữ liệu
  • Trích xuất trên toàn miền
  • Cuộc tấn công do nhà nước tài trợ
  • Thông tin nhận dạng của Google
  • Ứng dụng ngừng hoạt động
data

object

Không bắt buộc. Dữ liệu liên kết với cảnh báo này, ví dụ: google.apps.alertcenter.type.DeviceCompromised.
deleted

boolean

Chỉ có đầu ra. True nếu thông báo này được đánh dấu để xoá.
metadata

object (AlertMetadata)

Chỉ có đầu ra. Siêu dữ liệu liên kết với cảnh báo này.
updateTime

string (Timestamp format)

Chỉ có đầu ra. Thời gian mà thông báo này được cập nhật lần gần đây nhất.
etag

string

Không bắt buộc. etag được dùng để kiểm soát mô hình đồng thời một cách lạc quan nhằm ngăn việc đồng thời cập nhật một cảnh báo ghi đè lên nhau. Các hệ thống nên sử dụng etag trong chu kỳ đọc-sửa đổi-ghi để thực hiện cập nhật cảnh báo nhằm tránh các điều kiện tranh đấu: etag được trả về trong phản hồi có chứa cảnh báo và hệ thống cần đặt thẻ etag đó vào yêu cầu cập nhật cảnh báo để đảm bảo rằng thay đổi của chúng sẽ được áp dụng cho cùng một phiên bản cảnh báo.

Nếu không có etag nào được cung cấp trong lệnh gọi để cập nhật cảnh báo, thì cảnh báo hiện có sẽ bị ghi đè một cách mù quáng.

AlertMetadata

Siêu dữ liệu về cảnh báo.

Biểu diễn dưới dạng JSON 
{
  "customerId": string,
  "alertId": string,
  "status": string,
  "assignee": string,
  "updateTime": string,
  "severity": string,
  "etag": string
}
Trường
customerId

string

Chỉ có đầu ra. Mã nhận dạng duy nhất của tài khoản Google Workspace của khách hàng.
alertId

string

Chỉ có đầu ra. Giá trị nhận dạng cảnh báo.
status

string

Trạng thái hiện tại của cảnh báo. Sau đây là các giá trị được hỗ trợ:

  • NOT_STARTED
  • IN_PROGRESS
  • ĐÃ ĐÓNG
assignee

string

Địa chỉ email của người dùng được chỉ định cho cảnh báo.
updateTime

string (Timestamp format)

Chỉ có đầu ra. Thời điểm cập nhật siêu dữ liệu này lần gần đây nhất.
severity

string

Giá trị mức độ nghiêm trọng của cảnh báo. Trung tâm thông báo sẽ đặt trường này tại thời điểm tạo thông báo, mặc định là một chuỗi trống khi không xác định được trường này. Các giá trị được hỗ trợ cho thao tác cập nhật trên trường này như sau:

  • CAO
  • VỪA PHẢI
  • THẤP
etag

string

Không bắt buộc. etag được dùng để kiểm soát mô hình đồng thời một cách lạc quan nhằm ngăn việc đồng thời cập nhật một siêu dữ liệu cảnh báo ghi đè lên nhau. Các hệ thống nên sử dụng etag trong chu kỳ đọc-sửa đổi-ghi để cập nhật siêu dữ liệu nhằm tránh tình trạng tương tranh: etag được trả về trong phản hồi có chứa siêu dữ liệu cảnh báo, và các hệ thống cần đặt thẻ etag đó vào yêu cầu cập nhật siêu dữ liệu cảnh báo để đảm bảo rằng thay đổi của chúng sẽ được áp dụng cho cùng một phiên bản siêu dữ liệu cảnh báo.

Nếu không có etag nào được cung cấp trong lệnh gọi để cập nhật siêu dữ liệu cảnh báo, thì siêu dữ liệu cảnh báo hiện có sẽ bị ghi đè một cách mù quáng.

Phương thức

batchDelete

 Thực hiện thao tác xoá hàng loạt trên các cảnh báo.

batchUndelete

 Thực hiện thao tác huỷ xoá hàng loạt trên các cảnh báo.

delete

 Đánh dấu cảnh báo đã chỉ định để xoá.

get

 Nhận thông báo đã chỉ định.

getMetadata

 Trả về siêu dữ liệu của cảnh báo.

list

 Liệt kê các cảnh báo.

undelete

 Khôi phục, hay "huỷ xoá", một cảnh báo được đánh dấu để xoá trong vòng 30 ngày qua.