› › ›

已弃用的 7.x API

编辑

已弃用的 7.x API编辑

这些 API 已弃用，并将在未来的版本中删除。

旧版获取连接器 API编辑

已在 7.13.0 中弃用。

请改用获取连接器。

按 ID 检索连接器。

请求编辑

GET <kibana 主机>:<端口>/api/actions/action/<id>

GET <kibana 主机>:<端口>/s/<空间 ID>/api/actions/action/<id>

路径参数编辑

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

响应代码编辑

200: 表示调用成功。

示例编辑

$ curl -X GET api/actions/action/c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad

API 返回以下内容

{
  "id": "c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad",
  "actionTypeId": ".index",
  "name": "my-connector",
  "config": {
    "index": "test-index",
    "refresh": false,
    "executionTimeField": null
  },
  "isPreconfigured": false,
  "isDeprecated": false,
  "isMissingSecrets": false
}

旧版获取所有连接器 API编辑

已在 7.13.0 中弃用。

请改用获取所有连接器。

检索所有连接器。

请求编辑

GET <kibana 主机>:<端口>/api/actions

GET <kibana 主机>:<端口>/s/<空间 ID>/api/actions

路径参数编辑

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

响应代码编辑

200: 表示调用成功。

示例编辑

$ curl -X GET api/actions

API 返回以下内容

[
  {
    "id": "preconfigured-mail-action",
    "actionTypeId": ".email",
    "name": "email: preconfigured-mail-action",
    "isPreconfigured": true,
    "isDeprecated": false
  },
  {
    "id": "c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad",
    "actionTypeId": ".index",
    "name": "my-action",
    "config": {
      "index": "test-index",
      "refresh": false,
      "executionTimeField": null
    },
    "isPreconfigured": false,
    "isDeprecated": false,
    "isMissingSecrets": false
  }
]

旧版列出连接器类型 API编辑

已在 7.13.0 中弃用。

请改用列出所有连接器类型。

检索所有连接器类型的列表。

请求编辑

GET <kibana 主机>:<端口>/api/actions/list_action_types

GET <kibana 主机>:<端口>/s/<空间 ID>/api/actions/list_action_types

路径参数编辑

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

响应代码编辑

200: 表示调用成功。

示例编辑

$ curl -X GET api/actions/list_action_types

API 返回以下内容

[
  {
    "id": ".email", 
    "name": "Email", 
    "minimumLicenseRequired": "gold", 
    "enabled": false, 
    "enabledInConfig": true, 
    "enabledInLicense": false 
  },
  {
    "id": ".index",
    "name": "Index",
    "minimumLicenseRequired": "basic",
    "enabled": true,
    "enabledInConfig": true,
    "enabledInLicense": true
  }
]

	`id` - 连接器类型的唯一 ID。
	`name` - 连接器类型的名称。
	`minimumLicenseRequired` - 使用连接器类型所需的许可证。
	`enabled` - 指定连接器类型在 Kibana 中是启用还是禁用。
	`enabledInConfig` - 指定连接器类型在 Kibana .yml 文件中是启用还是禁用。
	`enabledInLicense` - 指定连接器类型在许可证中是启用还是禁用。

旧版创建连接器 API编辑

已在 7.13.0 中弃用。

请改用创建连接器。

创建连接器。

请求编辑

POST <kibana 主机>:<端口>/api/actions/action

POST <kibana 主机>:<端口>/s/<空间 ID>/api/actions/action

路径参数编辑

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

请求正文编辑

name: （必填，字符串）连接器的显示名称。
actionTypeId: （必填，字符串）连接器的连接器类型 ID。
config: （必填，对象）连接器的配置。配置属性因连接器类型而异。有关配置属性的信息，请参阅操作和连接器类型。
secrets: （必填，对象）连接器的密钥配置。密钥配置属性因连接器类型而异。有关密钥配置属性的信息，请参阅操作和连接器类型。

请记住这些值。每次调用更新 API 时都必须提供它们。

响应代码编辑

200: 表示调用成功。

示例编辑

$ curl -X POST api/actions/action  -H 'kbn-xsrf: true' -H 'Content-Type: application/json' -d '
{
  "name": "my-connector",
  "actionTypeId": ".index",
  "config": {
    "index": "test-index"
  }
}'

API 返回以下内容

{
  "id": "c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad",
  "actionTypeId": ".index",
  "name": "my-connector",
  "config": {
    "index": "test-index",
    "refresh": false,
    "executionTimeField": null
  },
  "isPreconfigured": false,
  "isDeprecated": false,
  "isMissingSecrets": false
}

旧版更新连接器 API编辑

已在 7.13.0 中弃用。

请改用更新连接器。

更新现有连接器的属性。

请求编辑

PUT <kibana 主机>:<端口>/api/actions/action/<id>

PUT <kibana 主机>:<端口>/s/<空间 ID>/api/actions/action/<id>

路径参数编辑

id: （必填，字符串）连接器的 ID。
space_id: （可选，字符串）空间的标识符。如果 URL 中未提供 space_id，则使用默认空间。

请求正文编辑

name: （必填，字符串）连接器的新名称。
config: （必填，对象）新的连接器配置。配置属性因连接器类型而异。有关配置属性的信息，请参阅操作和连接器类型。
secrets: （必填，对象）连接器的更新后的密钥配置。密钥属性因连接器类型而异。有关密钥配置属性的信息，请参阅操作和连接器类型。

响应代码编辑

200: 表示调用成功。

示例编辑

$ curl -X PUT api/actions/action/c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad  -H 'kbn-xsrf: true' -H 'Content-Type: application/json' -d '
{
  "name": "updated-connector",
  "config": {
    "index": "updated-index"
  }
}'

API 返回以下内容

{
  "id": "c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad",
  "actionTypeId": ".index",
  "name": "updated-connector",
  "config": {
    "index": "updated-index",
    "refresh": false,
    "executionTimeField": null
  },
  "isPreconfigured": false,
  "isDeprecated": false,
  "isMissingSecrets": false
}

旧版执行连接器 API编辑

已在 7.13.0 中弃用。

请改用运行连接器。

按 ID 执行连接器。

请求编辑

POST <kibana 主机>:<端口>/api/actions/action/<id>/_execute

POST <kibana 主机>:<端口>/s/<空间 ID>/api/actions/action/<id>/_execute

路径参数编辑

id: （必填，字符串）连接器的 ID。
space_id: （可选，字符串）空间的标识符。如果 URL 中未提供 space_id，则使用默认空间。

请求正文编辑

params: （必填，对象）连接器的参数。参数属性因连接器类型而异。有关参数属性的信息，请参阅操作和连接器类型。

响应代码编辑

200: 表示调用成功。

示例编辑

$ curl -X POST api/actions/action/c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad/_execute  -H 'kbn-xsrf: true' -H 'Content-Type: application/json' -d '
{
  "params": {
    "documents": [
      {
        "id": "test_doc_id",
        "name": "test_doc_name",
        "message": "hello, world"
      }
    ]
  }
}'

API 返回以下内容

{
  "status": "ok",
  "data": {
    "took": 197,
    "errors": false,
    "items": [
      {
        "index": {
          "_index": "updated-index",
          "_id": "iKyijHcBKCsmXNFrQe3T",
          "_version": 1,
          "result": "created",
          "_shards": {
            "total": 2,
            "successful": 1,
            "failed": 0
          },
          "_seq_no": 0,
          "_primary_term": 1,
          "status": 201
        }
      }
    ]
  },
  "actionId": "c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad"
}

旧版删除连接器 API编辑

已在 7.13.0 中弃用。

请改用删除连接器。

按 ID 删除连接器。

删除连接器后，*将无法恢复*。

请求编辑

DELETE <kibana 主机>:<端口>/api/actions/action/<id>

DELETE <kibana 主机>:<端口>/s/<空间 ID>/api/actions/action/<id>

路径参数编辑

id: （必填，字符串）连接器的 ID。
space_id: （可选，字符串）空间的标识符。如果 URL 中未提供 space_id，则使用默认空间。

响应代码编辑

200: 表示调用成功。

示例编辑

$ curl -X DELETE api/actions/action/c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad

« 更新连接器 API 案例 API »