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 天內標示為刪除的快訊。