› › ›

创建短 URL API

[预览] 此功能为技术预览版，未来版本中可能会更改或删除。Elastic 将努力修复任何问题，但技术预览版中的功能不受官方 GA 功能的支持 SLA 约束。创建 Kibana 短 URL。Kibana URL 可能很长且繁琐，短 URL 更容易记住和共享。

通过指定定位器 ID 和定位器参数来创建短 URL。当解析短 URL 时，将使用定位器 ID 和定位器参数将用户重定向到正确的 Kibana 页面。

请求

编辑

POST <kibana host>:<port>/api/short_url

请求正文

编辑

locatorId: （必需，字符串）定位器的 ID。
params: （必需，对象）包含给定定位器解析为 Kibana 位置所需的所有参数的对象。

当您创建短 URL 时，不会验证定位器参数，这允许您将任意且格式不正确的数据传递到 API 中，这可能会破坏 Kibana。请确保您发送到 API 的任何数据都已正确格式化。
slug: （可选，字符串）自定义短 URL 别名。别名是短 URL 中标识它的部分。您可以提供由拉丁字母、数字和 -._ 字符组成的自定义别名。别名必须至少 3 个字符长，但不超过 255 个字符。
humanReadableSlug: （可选，布尔值）当省略 slug 参数时，如果 humanReadableSlug 设置为 true，API 将生成一个随机的人类可读的别名。

响应代码

编辑

200: 表示调用成功。

示例

编辑

$ curl -X POST api/short_url  -H 'kbn-xsrf: true' -H 'Content-Type: application/json' -d '
{
  "locatorId": "LOCATOR_ID",
  "params": {},
  "humanReadableSlug": true
}'

API 返回以下内容

{
  "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", 
  "slug": "adjective-adjective-noun", 
  "locator": {
    "id": "LOCATOR_ID",
    "version": "x.x.x", 
    "state": {} 
  },
  "accessCount": 0,
  "accessDate": 1632680100000,
  "createDate": 1632680100000
}

	自动生成随机 ID。
	如果 `humanReadableSlug` 参数设置为 `true`，则自动生成随机的人类可读的别名。如果设置为 `false`，则会生成一个随机的短字符串。
	存储创建短 URL 时的 Kibana 版本。
	存储作为 `params` 属性提供的定位器参数。

« 短 URL API 获取短 URL API »