› › ›

创建连接器 API

创建连接器 API编辑

此功能处于测试阶段，可能会发生变化。其设计和代码不如正式的 GA 功能成熟，因此按原样提供，不作任何保证。测试功能不受正式 GA 功能的支持 SLA 的约束。

创建 Elastic 连接器。连接器是 Elasticsearch 集成，可从第三方数据源引入内容，这些数据源可以部署在 Elastic Cloud 上或托管在您自己的基础架构上。

原生连接器 是 Elastic Cloud 上的一项托管服务。
连接器客户端 在您的基础架构上进行自我管理。

在连接器文档中查找所有受支持服务类型的列表。

要开始使用连接器 API，请查看教程。

response = client.connector.put(
  connector_id: 'my-connector',
  body: {
    index_name: 'search-google-drive',
    name: 'My Connector',
    service_type: 'google_drive'
  }
)
puts response

PUT _connector/my-connector
{
  "index_name": "search-google-drive",
  "name": "My Connector",
  "service_type": "google_drive"
}

请求编辑

POST _connector

PUT _connector/<connector_id>

先决条件编辑

要使用自管连接器同步数据，您需要在自己的基础架构上部署Elastic 连接器服务。此服务在 Elastic Cloud 上自动运行，用于原生连接器。
service_type 参数应引用受支持的第三方服务。请参阅原生和自管连接器的可用服务类型。这也可以引用您的自定义连接器的服务类型。

描述编辑

在内部索引中创建连接器文档，并使用默认值初始化其配置、过滤和调度。这些值可以在以后根据需要更新。

路径参数编辑

<connector_id>: （必填，字符串）连接器的唯一标识符。

请求正文编辑

description: （可选，字符串）连接器的描述。
index_name: （可选，字符串）要同步数据的目标索引。如果索引不存在，则将在第一次同步时创建。
name: （可选，字符串）连接器的名称。在 Kibana 中管理连接器时，建议设置连接器名称。
is_native: （可选，布尔值）指示它是否是原生连接器。默认为 false。
language: （可选，字符串）数据的语言分析器。仅限于支持的语言。
service_type: （可选，字符串）连接器服务类型。可以引用 Elastic 支持的第三方服务或自定义连接器类型。请参阅原生和自管连接器的可用服务类型。

响应正文编辑

id: （字符串）与连接器文档关联的 ID。在使用 POST 请求时返回。
result: （字符串）索引操作的结果，created 或 updated。在使用 PUT 请求时返回。

响应代码编辑

200: 表示现有连接器已成功更新。
201: 表示连接器已成功创建。
400: 表示请求格式错误。

示例编辑

response = client.connector.put(
  connector_id: 'my-connector',
  body: {
    index_name: 'search-google-drive',
    name: 'My Connector',
    description: 'My Connector to sync data to Elastic index from Google Drive',
    service_type: 'google_drive',
    language: 'english'
  }
)
puts response

PUT _connector/my-connector
{
  "index_name": "search-google-drive",
  "name": "My Connector",
  "description": "My Connector to sync data to Elastic index from Google Drive",
  "service_type": "google_drive",
  "language": "english"
}

API 返回以下结果

{
  "result": "created"
}

« 连接器 API 删除连接器 API »