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
}
Các trường
customerId

string

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

string

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

string (Timestamp format)

Chỉ đầu ra. Thời điểm cảnh báo này được tạo.
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 gian xảy ra sự kiện khiến 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, chế độ này sẽ 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ả sau khi tạo cảnh báo. Để biết danh sách các loại cảnh báo hiện có, hãy xem Các loại cảnh báo của Google Workspace.
source

string

Bắt buộc. Giá trị nhận dạng riêng biệt cho hệ thống đã báo cáo cảnh báo. Đây chỉ là kết quả sau khi tạo cảnh báo.

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

  • 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ợ
  • Danh tính trên 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ụ như google.apps.alertcenter.type.DeviceCompromised.
deleted

boolean

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

object (AlertMetadata)

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

string (Timestamp format)

Chỉ đầu ra. Thời điể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 dùng để kiểm soát đồng thời lạc quan như một cách giúp ngăn chặn việc cập nhật đồng thời 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-ghi để thực hiện cập nhật cảnh báo nhằm tránh tình trạng tranh đua: etag được trả về trong phản hồi có chứa cảnh báo, và các hệ thống dự kiến sẽ đặt etag đó trong yêu cầu cập nhật cảnh báo để đảm bảo 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.

Cảnh báo siêu dữ liệu

Siêu dữ liệu 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
}
Các trường
customerId

string

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

string

Chỉ đầ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. Các giá trị được hỗ trợ như sau:

  • KHÔNG_BẮT ĐẦU
  • TRONG TIẾN TRÌNH
  • ĐÃ ĐÓNG
assignee

string

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

string (Timestamp format)

Chỉ đầu ra. Lần 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 cảnh báo, mặc định là trường trống khi không thể xác định trường này. Các giá trị được hỗ trợ cho các hành động cập nhật trên trường này là:

  • CAO
  • TƯƠNG ĐỐI NHIỀU
  • THẤP
etag

string

Không bắt buộc. etag dùng để kiểm soát đồng thời lạc quan như một cách để giúp ngăn chặn tình trạng cập nhật đồng thời 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-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 có 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 các hệ thố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 pháp

batchDelete

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

batchUndelete

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

delete

 Đánh dấu cảnh 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ả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.