跳到主要内容

更新连接器名称和描述 API

警告

此功能处于测试版(beta),可能会发生变化。其设计和代码不如正式发布(GA)功能成熟,按"原样"提供,不附带任何保证。测试版功能不受正式 GA 功能的支持 SLA 约束。

新版 API 参考

有关最新的 API 详情,请参阅连接器 API

更新连接器的名称和描述字段。

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

请求

PUT _connector/<connector_id>/_name

前置条件

  • 要使用自托管连接器同步数据,你需要在自己的基础设施上部署 Elastic 连接器服务。对于 Elastic 托管连接器,此服务在 Elastic Cloud 上自动运行。
  • connector_id 参数应引用一个现有的连接器。

路径参数

  • <connector_id>(必需,字符串)

    连接器的唯一标识符。

请求体

  • name(必需,字符串)

    连接器的名称。

  • description(可选,字符串)

    连接器的描述。

响应码

  • 200:连接器名称和描述字段已成功更新。
  • 400:未提供 connector_id 或请求负载格式不正确。
  • 404(缺少资源):找不到匹配 connector_id 的连接器。

示例

以下示例更新 ID 为 my-connector 的连接器的名称和描述字段:

PUT _connector/my-connector/_name
{
"name": "Custom connector",
"description": "This is my customized connector"
}

API 返回以下结果:

{
"result": "updated"
}

原文链接