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

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

  • 高
  • MEDIUM
  • 低
etag

string

可选。etag 用于乐观并发控制，可帮助防止同时对提醒元数据进行的更新相互覆盖。强烈建议系统在读取-修改-写入周期中使用 etag 执行元数据更新，以避免出现竞争条件：系统会在包含提醒元数据的响应中返回 etag，并且系统应将该 etag 放入用于更新提醒元数据的请求中，以确保其更改会应用于同一版本的提醒元数据。

如果在调用更新提醒元数据时未提供 etag，则现有提醒元数据将被盲目覆盖。

方法

batchDelete

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

batchUndelete

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

delete

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

get

 获取指定的提醒。

getMetadata

 返回提醒的元数据。

list

 列出提醒。

undelete

 恢复（即“取消删除”）过去 30 天内被标记为要删除的提醒。