› › ›

向案例 API 添加评论

编辑

向案例 API 添加评论编辑

向案例添加评论或警报。

有关最新 API 详细信息，请参阅开放 API 规范。

请求编辑

POST <kibana 主机>:<端口>/api/cases/<案例 ID>/comments

POST <kibana 主机>:<端口>/s/<空间 ID>/api/cases/<案例 ID>/comments

先决条件编辑

您必须对案例功能具有 所有 权限，该功能位于管理、可观察性 或安全部分的 Kibana 功能权限中，具体取决于您正在更新的案例的 所有者。

路径参数编辑

<案例 ID>: (必填，字符串) 案例的标识符。要检索案例 ID，请使用查找案例。
<空间 ID>: (可选，字符串) 空间的标识符。如果未指定，则使用默认空间。

请求正文编辑

alertId

(必填*，字符串或字符串数组) 警报标识符。仅当 type 为 alert 时才需要。您可以使用字符串数组将多个警报添加到案例中，前提是它们都与同一规则相关；index 也必须是具有相同长度或元素数量的数组。建议以这种方式添加多个警报，而不是多次调用 API。 [预览] 此功能处于技术预览阶段，可能会在将来的版本中更改或删除。Elastic 将努力解决任何问题，但技术预览中的功能不受官方 GA 功能支持 SLA 的约束。

comment

(必填*，字符串) 新评论。仅当 type 为 user 时才需要。

index

(必填*，字符串或字符串数组) 警报索引。仅当 type 为 alert 时才需要。如果您要将多个警报添加到案例中，请使用字符串数组；数组中每个索引名称的位置必须与 alertId 数组中相应警报标识符的位置匹配。 [预览] 此功能处于技术预览阶段，可能会在将来的版本中更改或删除。Elastic 将努力解决任何问题，但技术预览中的功能不受官方 GA 功能支持 SLA 的约束。

owner

(必填，字符串) 拥有案例的应用程序。有效值为：cases、observability 或 securitySolution。

rule

(必填*，对象) 与警报关联的规则。仅当 type 为 alert 时才需要。 [预览] 此功能处于技术预览阶段，可能会在将来的版本中更改或删除。Elastic 将努力解决任何问题，但技术预览中的功能不受官方 GA 功能支持 SLA 的约束。

rule 的属性

id: (必填，字符串) 规则标识符。 [预览] 此功能处于技术预览阶段，可能会在将来的版本中更改或删除。Elastic 将努力解决任何问题，但技术预览中的功能不受官方 GA 功能支持 SLA 的约束。
name: (必填，字符串) 规则名称。 [预览] 此功能处于技术预览阶段，可能会在将来的版本中更改或删除。Elastic 将努力解决任何问题，但技术预览中的功能不受官方 GA 功能支持 SLA 的约束。

type

(必填，字符串) 评论类型，必须为 user 或 alert。

响应代码编辑

200: 表示调用成功。

示例编辑

向案例 ID 293f1bc0-74f6-11ea-b83a-553aecdb28b6 添加评论

POST api/cases/293f1bc0-74f6-11ea-b83a-553aecdb28b6/comments
{
  "type": "user",
  "comment": "A new comment.",
  "owner": "cases"
}

API 返回有关案例及其评论的详细信息。例如

{
  "comments":[
    {
      "id": "8af6ac20-74f6-11ea-b83a-553aecdb28b6",
      "version": "WzIwNDMxLDFd",
      "type": "user",
      "owner": "cases",
      "comment": "A new comment.",
      "created_at": "2022-03-24T00:49:47.716Z",
      "created_by": {
        "email": null,
        "full_name": null,
        "username": "elastic"
      },
      "pushed_at": null,
      "pushed_by": null,
      "updated_at": null,
      "updated_by": null
    }
  ],
  "totalAlerts": 0,
  "id": "293f1bc0-74f6-11ea-b83a-553aecdb28b6",
  "version": "WzIzMzgsMV0=",
  "totalComment": 1,
  "title": "Case title 1",
  "tags": ["tag 1"],
  "description": "A case description.",
  "settings": {
    "syncAlerts": false
  },
  "owner": "cases",
  "duration": null,
  "severity": "low",
  "closed_at": null,
  "closed_by": null,
  "created_at": "2022-03-24T00:37:03.906Z",
  "created_by": {
    "email": null,
    "full_name": null,
    "username": "elastic"
  },
  "status": "open",
  "updated_at": "2022-03-24T00:49:47.716Z",
  "updated_by": {
    "email": null,
    "full_name": null,
    "username": "elastic"
  },
  "connector": {
    "id": "none",
    "name": "none",
    "type": ".none",
    "fields": null
  },
  "external_service": null
}

向案例添加警报

POST api/cases/293f1bc0-74f6-11ea-b83a-553aecdb28b6/comments
{
  "alertId": "6b24c4dc44bc720cfc92797f3d61fff952f2b2627db1fb4f8cc49f4530c4ff42",
  "index": ".internal.alerts-security.alerts-default-000001",
  "type": "alert",
  "owner": "cases",
  "rule": {
    "id":"94d80550-aaf4-11ec-985f-97e55adae8b9",
    "name":"security_rule"
  }
}

« 案例 API 创建案例 API »