REST Resource: alerts

資源：Alert

影響客戶的快訊。

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 帳戶的專屬 ID。
alertId

string

僅供輸出。警示的專屬 ID。
createTime

string (Timestamp format)

僅供輸出。建立這則快訊的時間。
startTime

string (Timestamp format)

必要欄位。導致這則快訊的事件開始或偵測到的時間。
endTime

string (Timestamp format)

選用設定。導致這則快訊的事件停止運作的時刻。如果提供結束時間，則該時間不得早於開始時間。如果未提供，則表示快訊仍在進行中。
type

string

必要欄位。快訊類型。只有在建立警報後才會輸出。如需可用快訊類型的清單，請參閱「Google Workspace 快訊類型」。
source

string

必要欄位。回報警報的系統專屬 ID。只有在建立警報後才會輸出。

系統支援的來源包括：

  • 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 放入更新快訊的要求中，確保變更會套用至相同版本的快訊。

如果呼叫更新快訊時未提供 etag，則系統會盲目覆寫現有快訊。

AlertMetadata

快訊中繼資料。

JSON 表示法 
{
  "customerId": string,
  "alertId": string,
  "status": string,
  "assignee": string,
  "updateTime": string,
  "severity": string,
  "etag": string
}
欄位
customerId

string

僅供輸出。客戶 Google Workspace 帳戶的專屬 ID。
alertId

string

僅供輸出。快訊 ID。
status

string

快訊目前的狀態。支援的值如下：

  • NOT_STARTED
  • IN_PROGRESS
  • 已結案
assignee

string

指派給快訊的使用者電子郵件地址。
updateTime

string (Timestamp format)

僅供輸出。中繼資料上次更新的時間。
severity

string

快訊的嚴重程度值。快訊中心會在建立快訊時設定這個欄位，如果無法判斷，預設值為空字串。這個欄位的更新動作支援以下值：

  • 高
  • 中
  • 低
etag

string

選用設定。etag 用於開放式並行控制，有助防止警示中繼資料在同時更新時相互覆寫。強烈建議系統在讀取-修改-寫入週期中使用 etag，以便執行中繼資料更新作業，避免發生競爭狀況：回應中會傳回 etag，其中包含警示中繼資料，系統應將該 etag 放入要求，以便更新警示中繼資料，確保變更會套用至相同版本的警示中繼資料。

如果呼叫更新快訊中繼資料時未提供 etag，則系統會盲目覆寫現有的快訊中繼資料。

方法

batchDelete

 對快訊執行批次刪除作業。

batchUndelete

 對快訊執行批次取消刪除作業。

delete

 將指定的快訊標示為待刪除。

get

 取得指定的警報。

getMetadata

 傳回快訊的中繼資料。

list

 列出警報。

undelete

 還原過去 30 天內標示為刪除的快訊。