解析对象 API
编辑解析对象 API编辑
在 8.7.0 中已弃用。
将在未来版本中删除
通过任何旧的 URL 别名（如果存在）检索单个 Kibana 保存对象。
在某些情况下，当 Kibana 升级时，保存对象迁移可能需要重新生成一些对象 ID 以启用新功能。当对象的 ID 重新生成时，会为该对象创建一个旧的 URL 别名，以保留其旧的 ID。在这种情况下，可以使用解析 API 通过其新的 ID 或旧的 ID 检索该对象。
有关最新的 API 详细信息，请参阅 开放 API 规范。
请求编辑
GET <kibana 主机>:<端口>/api/saved_objects/resolve/<类型>/<id>
GET <kibana 主机>:<端口>/s/<空间 ID>/api/saved_objects/resolve/<类型>/<id>
路径参数编辑
-
space_id - (可选，字符串) 空间的标识符。如果 URL 中未提供
space_id，则使用默认空间。 -
type - (必需，字符串) 有效选项包括
visualization、dashboard、search、index-pattern、config。 -
id - (必需，字符串) 要检索的对象的 ID。
响应代码编辑
-
200 - 表示成功调用。
示例编辑
检索具有 my-pattern ID 的数据视图对象
$ curl -X GET api/saved_objects/resolve/index-pattern/my-pattern
API 返回以下内容
{
"saved_object": {
"id": "my-pattern",
"type": "index-pattern",
"version": 1,
"attributes": {
"title": "my-pattern-*"
}
},
"outcome": "exactMatch"
}
除了 saved_object 之外，还可以返回几个字段
-
outcome(必需字符串) — 以下值之一-
"exactMatch"— 一个文档完全匹配给定的 ID。 -
"aliasMatch"— 一个具有旧 URL 别名的文档匹配给定的 ID；在这种情况下，saved_object.id字段与给定的 ID 不同。 -
"conflict"— 两个文档匹配给定的 ID，一个完全匹配，另一个具有旧的 URL 别名；在这种情况下，saved_object对象是完全匹配，saved_object.id字段与给定的 ID 相同。
-
-
alias_target_id(可选字符串) — 如果outcome是"aliasMatch"或"conflict"，则响应还将包含alias_target_id字段。这意味着为另一个对象找到了别名，并且它描述了该其他对象的 ID。 -
alias_purpose(可选字符串) — 如果outcome是"aliasMatch"或"conflict"，则响应还将包含alias_purpose字段。这指示创建别名的原因，并且可以用来更改客户端的行为。以下值之一："savedObjectConversion"、"savedObjectImport"
客户端代码使用这些字段根据 outcome 不同地表现 — 了解更多。
在 testspace 中通过 ID 检索仪表板对象
$ curl -X GET s/testspace/api/saved_objects/resolve/dashboard/7adfa750-4c81-11e8-b3d7-01146121b73d
API 返回以下内容
{
"saved_object": {
"id": "7adfa750-4c81-11e8-b3d7-01146121b73d",
"type": "dashboard",
"updated_at": "2019-07-23T00:11:07.059Z",
"version": "WzQ0LDFd",
"attributes": {
"title": "[Flights] Global Flight Dashboard",
"hits": 0,
"description": "Analyze mock flight data for ES-Air, Logstash Airways, Kibana Airlines and JetBeats",
"panelsJSON": "[ . . . ]",
"optionsJSON": "{\"hidePanelTitles\":false,\"useMargins\":true}",
"version": 1,
"timeRestore": true,
"timeTo": "now",
"timeFrom": "now-24h",
"refreshInterval": {
"display": "15 minutes",
"pause": false,
"section": 2,
"value": 900000
},
"kibanaSavedObjectMeta": {
"searchSourceJSON": "{\"query\":{\"language\":\"kuery\",\"query\":\"\"},\"filter\":[],\"highlightAll\":true,\"version\":true}"
}
},
"references": [
{
"name": "panel_0",
"type": "visualization",
"id": "aeb212e0-4c84-11e8-b3d7-01146121b73d"
},
. . .
{
"name": "panel_18",
"type": "visualization",
"id": "ed78a660-53a0-11e8-acbd-0be0ad9d822b"
}
],
"migrationVersion": {
"dashboard": "7.0.0"
}
},
"outcome": "conflict",
"alias_target_id": "05becb88-e214-439a-a2ac-15fc783b5d01"
}