创建连接器 API
编辑创建连接器 API
编辑此功能为测试版，可能会发生更改。其设计和代码不如正式 GA 功能成熟，并且按原样提供，不提供任何保证。测试版功能不受正式 GA 功能的支持 SLA 约束。
创建一个 Elastic 连接器。连接器是 Elasticsearch 集成，可从第三方数据源引入内容，这些内容可以部署在 Elastic Cloud 上或托管在您自己的基础架构上。
- 托管连接器是 Elastic Cloud 上的托管服务。
- 自托管连接器是在您自己的基础架构上进行自托管。
在连接器文档中查找所有支持的服务类型的列表。
要开始使用连接器 API，请查看我们的教程。
resp = client.connector.put(
connector_id="my-connector",
index_name="search-google-drive",
name="My Connector",
service_type="google_drive",
)
print(resp)
response = client.connector.put(
connector_id: 'my-connector',
body: {
index_name: 'search-google-drive',
name: 'My Connector',
service_type: 'google_drive'
}
)
puts response
const response = await client.connector.put({
connector_id: "my-connector",
index_name: "search-google-drive",
name: "My Connector",
service_type: "google_drive",
});
console.log(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 托管连接器，此服务在 Elastic Cloud 上自动运行。
service_type参数应引用受支持的第三方服务。请参阅Elastic 托管和自托管连接器的可用服务类型。 这也可以引用您自定义连接器的服务类型。
描述
编辑在内部索引中创建一个连接器文档，并使用默认值初始化其配置、筛选和计划。这些值可以稍后根据需要进行更新。
路径参数
编辑-
<connector_id> - (可选，字符串) 连接器的唯一标识符。
请求正文
编辑-
description - (可选，字符串) 连接器的描述。
-
index_name - (可选，字符串) 用于同步数据的目标索引。如果索引不存在，则会在首次同步时创建。
-
name - (可选，字符串) 连接器的名称。建议在 Kibana 中管理连接器时设置连接器名称。
-
is_native - (可选，布尔值) 指示它是否为托管连接器。默认为
false。 -
language - (可选，字符串) 数据的语言分析器。限制为支持的语言。
-
service_type - (可选，字符串) 连接器服务类型。可以引用 Elastic 支持的第三方服务或自定义连接器类型。请参阅Elastic 托管和自托管连接器的可用服务类型。
响应正文
编辑-
id - (字符串) 与连接器文档关联的 ID。 使用 POST 请求时返回。
-
result - (字符串) 索引操作的结果，
created或updated。使用 PUT 请求时返回。
响应代码
编辑-
200 - 指示现有连接器已成功更新。
-
201 - 指示已成功创建连接器。
-
400 - 指示请求格式错误。
示例
编辑resp = client.connector.put(
connector_id="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="en",
)
print(resp)
const response = await client.connector.put({
connector_id: "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: "en",
});
console.log(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": "en"
}
API 返回以下结果
{
"result": "created",
"id": "my-connector"
}