更新连接器配置 API
编辑更新连接器配置 API编辑
此功能处于测试阶段，可能会发生变化。设计和代码不如正式 GA 功能成熟，按原样提供，不提供任何保证。测试版功能不受正式 GA 功能支持 SLA 的约束。
更新连接器的 configuration，允许在已注册的配置模式中更新配置值。
要开始使用连接器 API，请查看 教程。
请求编辑
PUT _connector/<connector_id>/_configuration
先决条件编辑
- 要使用自管理连接器同步数据，您需要在自己的基础设施上部署 Elastic 连接器服务。此服务在 Elastic Cloud 上自动运行，用于原生连接器。
connector_id参数应引用现有连接器。- 要更新配置
values，连接器configuration模式必须首先由正在运行的 Elastic 连接器服务实例注册。 - 确保配置字段与第三方数据源的配置模式兼容。有关详细信息，请参阅各个 连接器参考。
路径参数编辑
-
<connector_id> - (必需，字符串)
请求正文编辑
-
values - (可选，对象) 连接器的配置值，表示为已注册模式中配置字段与其各自值的映射。
-
configuration - (可选，对象) 连接器的配置模式定义。配置字段是一个映射，其中每个键代表一个特定的配置字段名称，而值是一个
ConnectorConfiguration对象。对于连接器管理，请使用values传递配置值。configuration对象由 Elastic 连接器服务用于注册连接器配置模式。
响应代码编辑
-
200 - 连接器配置已成功更新。
-
400 - 未提供
connector_id或请求有效负载格式错误。 -
404(缺少资源) - 找不到与
connector_id匹配的连接器。
示例编辑
以下示例配置了 sharepoint_online 连接器。在 Sharepoint Online 连接器文档 中找到支持的配置选项，或者通过使用 获取连接器 检查连接器 configuration 字段中的模式。
PUT _connector/my-spo-connector/_configuration
{
"values": {
"tenant_id": "my-tenant-id",
"tenant_name": "my-sharepoint-site",
"client_id": "foo",
"secret_value": "bar",
"site_collections": "*"
}
}
{
"result": "updated"
}
首次设置连接器时，您需要提供所有必需的配置详细信息才能开始运行同步。但您也可以使用此 API 仅更新一部分字段。以下示例仅更新 sharepoint_online 连接器的 secret_value 字段。其他配置值不会改变。
PUT _connector/my-spo-connector/_configuration
{
"values": {
"secret_value": "foo-bar"
}
}
{
"result": "updated"
}