› › ›

导出对象 API

编辑

导出对象 API编辑

[预览] 此功能处于技术预览阶段，可能会在未来版本中更改或删除。Elastic 将努力修复任何问题，但技术预览版中的功能不属于官方 GA 功能的支持 SLA。检索要导入 Kibana 的已保存对象集。

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

请求编辑

POST <kibana 主机>:<端口>/api/saved_objects/_export

POST <kibana 主机>:<端口>/s/<空间 ID>/api/saved_objects/_export

路径参数编辑

空间 ID: （可选，字符串）空间的标识符。如果未在 URL 中提供 空间 ID，则使用默认空间。

请求正文编辑

类型: （可选，数组|字符串）要包含在导出中的已保存对象类型。使用 * 导出所有类型。
对象: （可选，数组）要导出的对象列表。
includeReferencesDeep: （可选，布尔值）包括导出对象中的所有引用对象。
excludeExportDetails: （可选，布尔值）不要在流的末尾添加导出详细信息条目。

您必须在请求正文中包含 类型 或 对象。

savedObjects.maxImportExportSize 配置设置限制了可以导出的已保存对象的数量。

响应正文编辑

响应正文的格式是用换行符分隔的 JSON。每个导出的对象都导出为有效的 JSON 记录，并用换行符 *\n* 分隔。

当 excludeExportDetails=false（默认值）时，我们在所有已保存对象记录之后的文件末尾附加一个导出结果详细信息记录。导出结果详细信息对象具有以下格式

{
  "exportedCount": 27,
  "missingRefCount": 2,
  "missingReferences": [
    { "id": "an-id", "type": "visualisation"},
    { "id": "another-id", "type": "index-pattern"}
  ]
}

响应代码编辑

200: 表示调用成功。

示例编辑

导出所有数据视图已保存对象

$ curl -X POST api/saved_objects/_export -H 'kbn-xsrf: true' -H 'Content-Type: application/json' -d '
{
  "type": "index-pattern"
}'

导出所有数据视图已保存对象，并从流中排除导出摘要

$ curl -X POST api/saved_objects/_export -H 'kbn-xsrf: true' -H 'Content-Type: application/json' -d '
{
  "type": "index-pattern",
  "excludeExportDetails": true
}'

导出特定的已保存对象

$ curl -X POST api/saved_objects/_export -H 'kbn-xsrf: true' -H 'Content-Type: application/json' -d '
{
  "objects": [
    {
      "type": "dashboard",
      "id": "be3733a0-9efe-11e7-acb3-3dab96693fab"
    }
  ]
}'

导出特定的已保存对象及其相关对象

$ curl -X POST api/saved_objects/_export -H 'kbn-xsrf: true' -H 'Content-Type: application/json' -d '
{
  "objects": [
    {
      "type": "dashboard",
      "id": "be3733a0-9efe-11e7-acb3-3dab96693fab"
    }
  ],
  "includeReferencesDeep": true
}'

导出所有可导出的已保存对象及其相关对象

$ curl -X POST api/saved_objects/_export -H 'kbn-xsrf: true' -H 'Content-Type: application/json' -d '
{
  "type": "*",
  "includeReferencesDeep": true
}'

« 已保存对象 API 导入对象 API »