批量获取对象 API
编辑批量获取对象 API编辑
已在 8.7.0 中弃用。
将在未来版本中删除
按 ID 检索多个 Kibana 已保存对象。
有关最新的 API 详细信息，请参阅开放 API 规范。
请求编辑
POST <kibana 主机>:<端口>/api/saved_objects/_bulk_get
POST <kibana 主机>:<端口>/s/<空间 ID>/api/saved_objects/_bulk_get
路径参数编辑
-
space_id - （可选，字符串）空间的标识符。如果未在 URL 中提供
space_id，则使用默认空间。
请求正文编辑
-
类型 - （必填，字符串）有效选项包括
visualization、dashboard、search、index-pattern、config。 -
ID - （必填，字符串）检索对象的 ID。ID 包括 Kibana 唯一标识符或自定义标识符。
-
字段 - （可选，数组）要在对象响应的
attributes键中返回的字段。 -
命名空间 -
（可选，字符串数组）用于搜索此对象的空间的标识符。如果提供了此选项，则仅在明确定义的空间中搜索对象。如果未提供此选项，则在当前空间中搜索对象（默认行为）。
- 对于可共享对象类型（使用
namespaceType: 'multiple'注册）：此选项可用于指定一个或多个空间，包括“所有空间”标识符 ('*')。 - 对于隔离对象类型（使用
namespaceType: 'single'或namespaceType: 'multiple-isolated'注册）：此选项只能用于指定单个空间，并且不允许使用“所有空间”标识符 ('*')。 - 对于全局对象类型（使用
namespaceType: 'agnostic'注册）：不能使用此选项。
- 对于可共享对象类型（使用
响应代码编辑
-
200 - 表示调用成功。请注意，此 HTTP 响应代码表示批量操作成功。与单个对象相关的错误将在响应正文中返回。有关详细信息，请参阅下面的示例。
示例编辑
检索 ID 为 my-pattern 的数据视图和 ID 为 my-dashboard 的仪表板
$ curl -X POST api/saved_objects/_bulk_get
[
{
"type": "index-pattern",
"id": "my-pattern"
},
{
"type": "dashboard",
"id": "be3733a0-9efe-11e7-acb3-3dab96693fab"
}
]
API 返回以下内容
{
"saved_objects": [
{
"id": "my-pattern",
"type": "index-pattern",
"version": 1,
"attributes": {
"title": "my-pattern-*"
}
},
{
"id": "my-dashboard",
"type": "dashboard",
"error": {
"statusCode": 404,
"message": "Not found"
}
}
]
}
仅存在数据视图。