更新连接器管道 API

编辑

此功能处于测试阶段,可能会发生变化。其设计和代码不如正式 GA 功能成熟,按“原样”提供,不附带任何担保。测试版功能不受正式 GA 功能的支持服务等级协议 (SLA) 的约束。

更新连接器的 pipeline 配置。

创建新的连接器时,摄取管道 的配置将填充默认设置。

要开始使用连接器 API,请查看我们的教程

请求

编辑

PUT _connector/<connector_id>/_pipeline

先决条件

编辑
  • 要使用自管理连接器同步数据,您需要在自己的基础设施上部署Elastic 连接器服务。对于 Elastic 托管连接器,此服务会在 Elastic Cloud 上自动运行。
  • connector_id 参数应引用现有连接器。

路径参数

编辑
<connector_id>
(必需,字符串)

请求正文

编辑
pipeline
(必需,对象) 连接器的管道配置。管道决定在将数据摄取到 Elasticsearch 期间如何处理数据。

管道配置必须包含以下属性

  • extract_binary_content (必需,布尔值) 指示在摄取期间是否提取二进制内容的标志。
  • name (必需,字符串) 摄取管道的名称。
  • reduce_whitespace (必需,布尔值) 指示是否减少摄取内容中多余空格的标志。
  • run_ml_inference (必需,布尔值) 指示是否对摄取内容运行机器学习推理的标志。

响应代码

编辑
200
连接器 pipeline 字段已成功更新。
400
未提供 connector_id 或请求有效负载格式错误。
404 (缺少资源)
找不到与 connector_id 匹配的连接器。

示例

编辑

以下示例更新了 ID 为 my-connector 的连接器的 pipeline 属性。

resp = client.connector.update_pipeline(
    connector_id="my-connector",
    pipeline={
        "extract_binary_content": True,
        "name": "my-connector-pipeline",
        "reduce_whitespace": True,
        "run_ml_inference": True
    },
)
print(resp)
response = client.connector.update_pipeline(
  connector_id: 'my-connector',
  body: {
    pipeline: {
      extract_binary_content: true,
      name: 'my-connector-pipeline',
      reduce_whitespace: true,
      run_ml_inference: true
    }
  }
)
puts response
const response = await client.connector.updatePipeline({
  connector_id: "my-connector",
  pipeline: {
    extract_binary_content: true,
    name: "my-connector-pipeline",
    reduce_whitespace: true,
    run_ml_inference: true,
  },
});
console.log(response);
PUT _connector/my-connector/_pipeline
{
    "pipeline": {
        "extract_binary_content": true,
        "name": "my-connector-pipeline",
        "reduce_whitespace": true,
        "run_ml_inference": true
    }
}
{
    "result": "updated"
}