REST Resource: alerts

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

Cảnh báo ảnh hưởng đến 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. Giá trị 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 gian tạo thông báo này.
startTime

string (Timestamp format)

Bắt buộc. Thời gian 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 điểm 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 không được cung cấp, thì giá trị này cho biế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 tạo cảnh báo. Để xem danh sách các loại cảnh báo hiện có, hãy xem bài viết Các loại cảnh 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 tạo cảnh báo.

Sau đây là các nguồn được hỗ trợ:

  • Nhóm điều hành của Google
  • Quản lý thiết bị di động
  • Lừa đảo trong Gmail
  • Tính năng ngăn chặn mất dữ liệu
  • Xuất dữ liệu 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 cảnh 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 cập nhật gần đây nhất của cảnh báo này.
etag

string

Không bắt buộc. etag được dùng để kiểm soát đồng thời một cách lạc quan, nhằm giúp ngăn chặn việc các bản cập nhật đồng thời của 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ác bản cập nhật cảnh báo nhằm tránh tình trạng tương tranh: etag được trả về trong phản hồi chứa các cảnh báo và hệ thống dự kiến sẽ đặt etag đó vào yêu cầu cập nhật cảnh báo để đảm bảo rằng thay đổi của họ 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 của thông 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. Giá trị 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 gian cập nhật siêu dữ liệu này 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. Sau đây là các giá trị được hỗ trợ cho hành động cập nhật trên trường này:

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

string

Không bắt buộc. etag được dùng để kiểm soát đồng thời một cách lạc quan, nhằm giúp ngăn chặn việc các bản cập nhật siêu dữ liệu cảnh báo đồng thời 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 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 chứa siêu dữ liệu cảnh báo và các hệ thống dự kiến sẽ đặt 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 đối với cảnh báo.

batchUndelete

 Thực hiện thao tác huỷ xoá hàng loạt đối với cảnh báo.

delete

 Đánh dấu thông báo đã chỉ định để xoá.

get

 Nhận cảnh báo đã chỉ định.

getMetadata

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

list

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

undelete

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