更新连接器 API 密钥 ID API
编辑更新连接器 API 密钥 ID API编辑
此功能处于测试阶段,可能会发生变化。设计和代码不如正式 GA 功能成熟,按原样提供,不提供任何担保。测试版功能不受正式 GA 功能支持 SLA 的约束。
更新连接器的 api_key_id
和/或 api_key_secret_id
字段,指定
- 用于授权的 API 密钥的 ID
- 存储 API 密钥的连接器密钥的 ID
连接器密钥 ID 仅对原生连接器是必需的。连接器客户端不使用此字段。有关详细信息,请参阅 以编程方式管理原生连接器 API 密钥 的文档。
要开始使用连接器 API,请查看 教程。
请求编辑
PUT _connector/<connector_id>/_api_key_id
先决条件编辑
- 要使用自管理连接器同步数据,您需要在自己的基础设施上部署 Elastic 连接器服务。此服务在 Elastic Cloud 上对原生连接器自动运行。
connector_id
参数应引用现有连接器。api_key_id
参数应引用现有 API 密钥。api_key_secret_id
参数应引用包含编码 API 密钥值的现有连接器密钥。
路径参数编辑
-
<connector_id>
- (必需,字符串)
请求正文编辑
-
api_key_id
- (可选,字符串) 连接器将用于授权访问所需索引的 API 密钥的 ID。每个连接器最多可以与一个 API 密钥关联。
-
api_key_secret_id
- (可选,字符串) 包含编码 API 密钥的连接器密钥的 ID。这应该与
api_key_id
引用的 API 密钥相同。这仅对原生连接器是必需的。
响应代码编辑
-
200
- 连接器
api_key_id
和/或api_key_secret_id
字段已成功更新。 -
400
- 未提供
connector_id
或请求有效负载格式错误。 -
404
(缺少资源) - 找不到与
connector_id
匹配的连接器。
示例编辑
以下示例更新了 ID 为 my-connector
的连接器的 api_key_id
和 api_key_secret_id
字段
PUT _connector/my-connector/_api_key_id { "api_key_id": "my-api-key-id", "api_key_secret_id": "my-connector-secret-id" }
{ "result": "updated" }