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