更新连接器状态 API

编辑

此功能处于技术预览阶段,可能会在未来的版本中更改或删除。 Elastic 将努力修复任何问题,但技术预览版中的功能不受官方 GA 功能的支持 SLA 约束。

更新连接器的 status

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

请求

编辑

PUT _connector/<connector_id>/_status

先决条件

编辑
  • 要使用自托管连接器同步数据,您需要在自己的基础设施上部署Elastic 连接器服务。 此服务在 Elastic Cloud 上为 Elastic 管理的连接器自动运行。
  • connector_id 参数应引用现有的连接器。
  • status 的更改必须是根据连接器协议的有效状态转换。

路径参数

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

请求正文

编辑
status
(必需,字符串) 连接器框架中定义的有效连接器状态字符串。

响应代码

编辑
200
连接器 status 字段已成功更新。
400
未提供 connector_id,请求负载格式不正确,或者不支持给定的状态转换。
404(缺少资源)
找不到与 connector_id 匹配的连接器。

示例

编辑

以下示例更新 ID 为 my-connector 的连接器的 status

resp = client.connector.update_status(
    connector_id="my-connector",
    status="needs_configuration",
)
print(resp)
response = client.connector.update_status(
  connector_id: 'my-connector',
  body: {
    status: 'needs_configuration'
  }
)
puts response
const response = await client.connector.updateStatus({
  connector_id: "my-connector",
  status: "needs_configuration",
});
console.log(response);
PUT _connector/my-connector/_status
{
    "status": "needs_configuration"
}
{
    "result": "updated"
}