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