更新连接器 API 密钥 ID API

编辑

更新连接器 API 密钥 ID API

编辑

此功能处于 Beta 阶段,可能会发生变化。其设计和代码不如正式 GA 功能成熟,按“原样”提供,不附带任何担保。Beta 功能不受正式 GA 功能的支持 SLA 的约束。

更新连接器的 api_key_id 和/或 api_key_secret_id 字段,指定

  1. 用于授权的 API 密钥的 ID
  2. 存储 API 密钥的连接器密钥的 ID

连接器密钥 ID 仅适用于 Elastic 托管的连接器。自管理连接器不使用此字段。有关更多详细信息,请参阅 以编程方式管理连接器 API 密钥 的文档。

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

请求

编辑

PUT _connector/<connector_id>/_api_key_id

先决条件

编辑
  • 要使用自管理连接器同步数据,您需要在自己的基础设施上部署 Elastic 连接器服务。此服务在 Elastic Cloud 上的 Elastic 托管连接器中自动运行。
  • 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 密钥相同。这仅适用于 Elastic 托管的连接器。

响应代码

编辑
200
连接器 api_key_id 和/或 api_key_secret_id 字段已成功更新。
400
未提供 connector_id 或请求有效负载格式错误。
404(缺少资源)
找不到与 connector_id 匹配的连接器。

示例

编辑

以下示例更新了 ID 为 my-connector 的连接器的 api_key_idapi_key_secret_id 字段。

resp = client.connector.update_api_key_id(
    connector_id="my-connector",
    api_key_id="my-api-key-id",
    api_key_secret_id="my-connector-secret-id",
)
print(resp)
response = client.connector.update_api_key_id(
  connector_id: 'my-connector',
  body: {
    api_key_id: 'my-api-key-id',
    api_key_secret_id: 'my-connector-secret-id'
  }
)
puts response
const response = await client.connector.updateApiKeyId({
  connector_id: "my-connector",
  api_key_id: "my-api-key-id",
  api_key_secret_id: "my-connector-secret-id",
});
console.log(response);
PUT _connector/my-connector/_api_key_id
{
    "api_key_id": "my-api-key-id",
    "api_key_secret_id": "my-connector-secret-id"
}
{
    "result": "updated"
}