获取案例 API编辑

返回有关案例的信息。

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

请求编辑

GET <kibana 主机名>:<端口>/api/cases/<案例 ID>

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

先决条件编辑

您必须拥有 Kibana 功能权限中“管理”、“可观察性”或“安全”部分中**案例**功能的读取权限,具体取决于您要查找的案例的所有者

路径参数编辑

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

查询参数编辑

includeComments
(可选,布尔值)确定是否返回案例评论。默认为true [8.1.0] 已在 8.1.0 中弃用。 includeComments 查询参数已弃用,并将在未来的版本中删除。

响应代码编辑

200
表示调用成功。

示例编辑

返回案例 ID 31cdada0-02c1-11ed-85f2-4f7c222ca2fa

GET api/cases/31cdada0-02c1-11ed-85f2-4f7c222ca2fa

API 返回一个包含检索到的案例的 JSON 对象。例如

{
  "id":"31cdada0-02c1-11ed-85f2-4f7c222ca2fa",
  "version":"WzM2LDFd",
  "comments":[{
    "id":"2134c1d0-02c2-11ed-85f2-4f7c222ca2fa",
    "version":"WzM3LDFd",
    "type":"user",
    "owner":"cases",
    "comment":"A new comment",
    "created_at":"2022-07-13T15:40:32.335Z",
    "created_by":{"email":null,"full_name":null,"username":"elastic"},
    "pushed_at":null,
    "pushed_by":null,
    "updated_at":null,
    "updated_by":null
  }],
  "totalComment":1,
  "totalAlerts":0,
  "title":"Case title 1",
  "tags":["tag 1"],
  "settings":{"syncAlerts":true},
  "owner":"cases",
  "description":"A case description",
  "duration":null, 
  "severity":"low",
  "closed_at":null,
  "closed_by":null,
  "created_at":"2022-07-13T15:33:50.604Z",
  "created_by":{"username":"elastic","email":null,"full_name":null},
  "status":"open",
  "updated_at":"2022-07-13T15:40:32.335Z",
  "updated_by":{"full_name":null,"email":null,"username":"elastic"},
  "assignees":[{"uid":"u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0"}],
  "connector":{"id":"none","name":"none","type":".none","fields":null},
  "external_service":null
}

持续时间表示从案例创建到关闭所经过的时间(以秒为单位)。如果案例尚未关闭,则持续时间设置为null。如果案例在不到半秒的时间内关闭,则持续时间向下舍入为零。