› › ›

创建短链接 API

创建短链接 API编辑

[预览] 此功能处于技术预览阶段，可能会在将来的版本中更改或删除。Elastic 将努力解决任何问题，但技术预览中的功能不受官方 GA 功能的支持 SLA 的约束。创建 Kibana 短链接。Kibana URL 可能很长且繁琐，短链接更容易记忆和分享。

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

请求编辑

POST <kibana 主机>:<端口>/api/short_url

请求正文编辑

locatorId: (必填，字符串) 定位器的 ID。
params: (必填，对象) 包含所有必要参数的对象，以便给定定位器解析为 Kibana 位置。

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

响应代码编辑

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`，则会自动生成一个随机的可读 slug。如果设置为 `false`，则会生成一个随机的短字符串。
	存储创建短链接时的 Kibana 版本。
	存储作为 `params` 属性提供的定位器参数。

« 短链接 API 获取短链接 API »