跳至主内容

更新事件备注

此方法用于为安全事件添加备注

重要提示

该方法已更新至1.1版本。1.0版本适用信息请参阅 本节内容 .

参数

参数

类型

可选

描述

type

字符串

目标事件的类型。可能取值:

  • incidents - 因新根因分析(RCA)生成并显示在 事件 章节下的 GravityZone 控制中心 中的事件。这些事件可在 终端事件 检测到的威胁 标签页下找到。

  • extendedIncidents - 此类事件位于 事件 页面中的 GravityZone 控制中心 扩展事件 标签页下。

incidentId

字符串

事件ID,从事件推送详情中获取。该值对应 incident_id 参数,来自 新建事件 新建扩展事件 事件类型。

提示

您可以通过以下步骤从 GravityZone 控制台获取特定事件的ID:

  1. 登录 GravityZone .

  2. 进入 事件 页面,找到需要更改状态的事件。

  3. 在目标事件所在行的表格右侧选择菜单项。

  4. 选择 查看事件和警报 .

    新浏览器窗口将打开显示事件详情。事件ID包含在页面URL中。

    示例

    https://cloudgz.gravityzone.bitdefender.com/#!/xdr/events/65dc39197a4a51fb2b7f15ee

备注

字符串

要包含在备注中的文本。

备注

若该事件已存在关联备注,原有备注将被覆盖。

返回值

本方法返回一个布尔值,当 True 时表示备注分配成功。

示例

请求 :

{
    "params": {
      "incidentId" : "621342db44747b408b7edf65",
      "type" : "extendedIncidents" 或 "incidents",
      "note" : "随机备注"
    },
    "jsonrpc": "2.0",
    "method": "updateIncidentNote",
    "id": "0df7568c-59c1-48e0-a31b-18d83e6d9810"
}

响应 :

{
    "id": "0df7568c-59c1-48e0-a31b-18d83e6d9810",
    "jsonrpc": "2.0",
    "result": true
}

版本1.0

参数

参数名

类型

可选性

说明

type

字符串

目标事件类型。可选值:

  • incidents - 因新增根本原因分析(RCA)生成的事件,将显示在 事件 分区的 GravityZone 控制中心 。此类事件可在 终端事件 检测到的威胁 标签页。

  • 扩展事件 - 这些事件可在 事件 页面中的 GravityZone 控制中心 找到,位于 扩展事件 标签下。

事件ID

字符串

从事件推送详情中获取的事件ID,其值对应 incident_id 参数(来自 新事件 事件类型)。

备注

字符串

需包含在备注中的文本内容。

注意

若该事件已存在关联备注,原有备注将被覆盖。

返回值

本方法返回一个布尔值,当值为 若笔记分配成功且返回以下对象:

  • data ,包含事件相关信息的对象。

    • lastUpdated - 笔记修改时的时间戳。

示例

请求 :

{
    "params": {
      "incidentId" : "621342db44747b408b7edf65",
      "type" : "extendedIncidents" 或 "incidents",
      "note" : "随机备注"
    },
    "jsonrpc": "2.0",
    "method": "updateIncidentNote",
    "id": "0df7568c-59c1-48e0-a31b-18d83e6d9810"
}

响应 :

{
    "id": "0df7568c-59c1-48e0-a31b-18d83e6d9810",
    "jsonrpc": "2.0",
    "result": {
        "success": true
    }
}