› › ›

API обновления идентификатора ключа API подключения

Эта функциональность находится в стадии бета-тестирования и может быть изменена. Дизайн и код менее зрелые, чем официальные функции GA, и предоставляются как есть без каких-либо гарантий. Функции бета-версии не подпадают под SLA поддержки официальных функций GA.

Обновляет поле(а) api_key_id и/или api_key_secret_id подключения, указывая:

Идентификатор ключа API, используемого для авторизации
Идентификатор секрета подключения, где хранится ключ API

Идентификатор секрета подключения требуется только для управляемых 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, который подключение будет использовать для авторизации доступа к необходимым индексам. Каждое подключение может быть связано с максимум одним ключом API.
api_key_secret_id: (Необязательно, строка) Идентификатор секрета подключения, содержащего закодированный ключ API. Он должен быть тем же ключом API, на который ссылается api_key_id. Это требуется только для управляемых Elastic подключений.

Коды ответов

200: Поле(а) подключения api_key_id и/или api_key_secret_id успешно обновлены.
400: Параметр connector_id не был предоставлен или тело запроса имело неправильный формат.
404 (Отсутствующие ресурсы): Не найдено подключение, соответствующее connector_id.

Примеры

В следующем примере обновляются поля api_key_id и api_key_secret_id для подключения с ID my-connector:

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"
}

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-connector-api-key-id-api.html