查找对象 API
编辑查找对象 API编辑
已在 8.7.0 中弃用。
将在未来版本中移除
根据各种条件检索 Kibana 已保存对象的分页集。
有关最新的 API 详细信息，请参阅开放 API 规范。
请求编辑
GET <kibana 主机>:<端口>/api/saved_objects/_find
GET <kibana 主机>:<端口>/s/<空间 ID>/api/saved_objects/_find
路径参数编辑
-
space_id - （可选，字符串）空间的标识符。如果未在 URL 中提供
space_id，则使用默认空间。
查询参数编辑
-
type - （必填，数组|字符串）要包含在导出中的已保存对象类型。
-
per_page - （可选，数字）每页返回的对象数。
-
page - （可选，数字）要返回的对象页码。
-
search - （可选，字符串）一个 Elasticsearch simple_query_string 查询，用于过滤响应中的对象。
-
default_search_operator - （可选，字符串）用于
simple_query_string的默认运算符。 -
search_fields - （可选，数组|字符串）要对其执行
simple_query_string解析查询的字段。 -
fields - （可选，数组|字符串）要在响应的
attributes键中返回的字段。 -
sort_field - （可选，字符串）对响应进行排序。包括“root”和“type”字段。“root”字段存在于所有已保存的对象中，例如“updated_at”。“type”字段特定于对象类型，例如在响应的
attributes键中返回的字段。当在type参数中定义了单个类型时，允许使用“root”和“type”字段，并按该顺序进行有效性检查。当在type参数中定义了多个类型时，只允许使用“root”字段。 -
has_reference - （可选，对象）过滤与类型和 ID 组合具有关系的对象。
-
has_reference_operator - （可选，字符串）用于
has_reference参数的运算符。可以是OR或AND。默认为OR。 -
has_no_reference - （可选，对象）过滤与类型和 ID 组合没有关系的对象。
-
has_no_reference_operator - （可选，字符串）用于
has_no_reference参数的运算符。可以是OR或AND。默认为OR。 -
filter - （可选，字符串）过滤器是一个 KQL 字符串，但需要注意的是，如果您使用已保存对象类型中的属性进行过滤，则应如下所示：
savedObjectType.attributes.title: "myTitle"。但是，如果您使用已保存对象的根属性（例如updated_at），则必须像这样定义过滤器：savedObjectType.updated_at > 2018-12-22。 -
aggs - （可选，字符串）**实验性** 聚合结构，序列化为字符串。字段格式类似于
filter，这意味着要在聚合中使用已保存对象类型属性，必须使用savedObjectType.attributes.title: "myTitle"` 格式。对于根字段，语法为savedObjectType.rootField
随着 Kibana 中对象的更改，响应每一页上的结果也会发生变化。使用 find API 可以获得传统的分页结果，但应避免使用它来导出大量数据。
响应代码编辑
-
200 - 表示调用成功。
示例编辑
查找标题以 my 开头的数据视图
$ curl -X GET api/saved_objects/_find?type=index-pattern&search_fields=title&search=my*
API 返回以下内容
{
"total": 1,
"data": [
{
"id": "my-pattern",
"type": "index-pattern",
"version": 1,
"attributes": {
"title": "my-pattern-*"
}
}
]
}
对于接受多个值的 parameter（例如 fields），请为每个值重复查询参数
$ curl -X GET api/saved_objects/_find?fields=id&fields=title