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

僅供輸出。快訊的專屬識別碼。

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 的快訊,則系統會覆寫現有的快訊。

快訊中繼資料

快訊中繼資料。

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

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

  • 非_STARTED
  • 處理中
  • 已結案
assignee

string

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

updateTime

string (Timestamp format)

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

severity

string

快訊的嚴重性值。快訊中心會在快訊建立時設定這個欄位;如果系統無法判斷此情況,則預設值為空白字串。這個欄位支援更新的值如下:

etag

string

選用,etag 用於提供同步並行控制,可協助避免同時更新快訊中繼資料。強烈建議您在讀取-修改-寫入週期中使用 etag 來執行中繼資料更新,以避免競爭狀況:在包含快訊中繼資料的回應中傳回 etag,且系統在要求更新快訊中繼資料時,會在要求中加入該 etag,以確保其變更將套用到相同的快訊中繼資料中繼資料。

如果呼叫期間沒有提供更新快訊中繼資料的 etag,則系統會直接覆寫現有的快訊中繼資料。

方法

batchDelete

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

batchUndelete

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

delete

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

get

取得指定的快訊。

getMetadata

傳回快訊的中繼資料。

list

列出快訊。

undelete

還原過去 30 天內標示為刪除的快訊 (也就是「取消刪除」)。