更新连接器名称和描述 API
编辑更新连接器名称和描述 API
编辑此功能处于 Beta 阶段，可能会发生变化。其设计和代码不如正式 GA 功能成熟，按“原样”提供，不提供任何保证。Beta 功能不受正式 GA 功能支持 SLA 的约束。
更新连接器的 name 和 description 字段。
要开始使用连接器 API，请查看 我们的教程。
请求
编辑PUT _connector/<connector_id>/_name
先决条件
编辑- 要使用自管理连接器同步数据，您需要在自己的基础设施上部署 Elastic 连接器服务。对于 Elastic 托管连接器，此服务在 Elastic Cloud 上自动运行。
connector_id参数应引用现有连接器。
路径参数
编辑-
<connector_id> - (必填，字符串)
请求正文
编辑-
name - (必填，字符串) 连接器的名称。
-
description - (可选，字符串) 连接器的描述。
响应代码
编辑-
200 - 连接器
name和description字段已成功更新。 -
400 - 未提供
connector_id或请求有效负载格式错误。 -
404(缺少资源) - 找不到与
connector_id匹配的连接器。
示例
编辑以下示例更新了 ID 为 my-connector 的连接器的 name 和 description 字段。
resp = client.connector.update_name(
connector_id="my-connector",
name="Custom connector",
description="This is my customized connector",
)
print(resp)
response = client.connector.update_name(
connector_id: 'my-connector',
body: {
name: 'Custom connector',
description: 'This is my customized connector'
}
)
puts response
const response = await client.connector.updateName({
connector_id: "my-connector",
name: "Custom connector",
description: "This is my customized connector",
});
console.log(response);
PUT _connector/my-connector/_name
{
"name": "Custom connector",
"description": "This is my customized connector"
}
{
"result": "updated"
}