查找列表容器编辑

检索列表容器的分页子集。默认情况下,将返回第一页,每页 20 个结果。

请求 URL编辑

GET <kibana 主机>:<端口>/api/lists/_find

URL 查询参数编辑

所有参数都是可选的

名称 类型 描述

页面

整数

要返回的页码。

每页

整数

每页返回的列表容器数量。

排序字段

字符串

确定用于排序结果的字段。

排序顺序

字符串

确定排序顺序,可以是 descasc

游标

字符串

返回在先前调用中返回的最后一个容器之后的容器(使用先前调用中返回的 cursor 值)。此参数使用 tie_breaker_id 字段来确保所有容器都已正确排序和返回。有关更多信息,请参见 搜索后

过滤器

字符串

根据指定字段的值过滤返回的结果,使用 <字段名称>:<字段值> 语法,其中 <字段名称> 可以是

  • 名称
  • 类型
  • 创建者
  • 更新者

示例请求编辑

检索前两个 keyword 列表容器,按 name 降序排序

GET api/lists/_find?filter=type:keyword&page=1&per_page=2&sort_field=name&sort_order=desc

响应代码编辑

200
表示成功调用。

响应有效负载编辑

{
  "cursor": "WzIwLFsiMTk1ZjU0ZmItMjQ0ZC00ZjlhLTlhNWItZTcyODkwMTM0N2UwIl1d",
  "data": [
    {
      "_version": "WzcsMV0=",
      "id": "internal-ip-excludes",
      "created_at": "2020-08-11T10:38:51.087Z",
      "created_by": "elastic",
      "description": "Contains list items that exclude internal IP addresses from detection rule matches.",
      "immutable": false,
      "name": "Trusted internal IP addresses",
      "tie_breaker_id": "195f54fb-244d-4f9a-9a5b-e728901347e0",
      "type": "ip",
      "updated_at": "2020-08-11T10:42:30.205Z",
      "updated_by": "elastic",
      "version": 1
    }
  ],
  "page": 1,
  "per_page": 20,
  "total": 1
}