REST Resource: alerts

资源:提醒

提醒客户。

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 帐号的唯一标识符。

alertId

string

仅供输出。提醒的唯一标识符。

createTime

string (Timestamp format)

仅供输出。此提醒的创建时间。

startTime

string (Timestamp format)

必需。导致此提醒的事件开始或检测到的时间。

endTime

string (Timestamp format)

(可选)导致此提醒的事件停止活跃的时间。如果提供,结束时间不得早于开始时间。如果未提供,则表示持续提醒。

type

string

必需。提醒的类型。只有在创建提醒后,系统才会输出此值。如需查看可用的提醒类型列表,请参阅 Google Workspace 提醒类型

source

string

必需。系统报告提醒的唯一标识符。只有在创建提醒后,系统才会输出此值。

支持的来源包括:

  • 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 帐号的唯一标识符。

alertId

string

仅供输出。提醒标识符。

status

string

提醒的当前状态。支持的值如下:

  • 尚未开始
  • IN_PROGRESS
  • 已解决
assignee

string

为提醒分配的用户的电子邮件地址。

updateTime

string (Timestamp format)

仅供输出。此元数据的上次更新时间。

severity

string

提醒的严重程度值。提醒中心会在创建提醒时设置此字段,如果无法确定,则默认值为空字符串。此字段的更新操作支持的值如下:

  • MEDIUM
etag

string

(可选)etag 用于乐观并发控制,可帮助防止对提醒元数据同时更新。强烈建议系统在“读取-修改-写入”周期中使用 etag 来执行元数据更新以避免竞态条件:系统会在响应中返回一个包含提醒元数据的 etag,系统应将该 etag 放入更新提醒元数据的请求中,以确保其更改将应用于同一版本的提醒元数据。

如果在更新提醒元数据的调用中未提供 etag,系统将盲目覆盖现有提醒元数据。

方法

batchDelete

对提醒执行批量删除操作。

batchUndelete

对提醒执行批量恢复删除操作。

delete

将指定的提醒标记为待删除。

get

获取指定的提醒。

getMetadata

返回提醒的元数据。

list

列出提醒。

undelete

恢复(或“删除”)过去 30 天内标记为删除的提醒。