› › ›

API для очистки кэша ключей API

Удаляет подмножество всех записей из кэша ключей API. Кэш также автоматически очищается при изменении состояния индекса безопасности.

Запрос

POST /_security/api_key/<ids>/_clear_cache

Предварительные условия

Для использования этого API необходимо обладать, как минимум, правом доступа manage_security к кластеру.

Описание

Дополнительную информацию о ключах API см. в разделах Создание ключей API, Получение информации о ключе API и Аннулирование ключа API.

Параметры пути

<ids>: (Обязательно, строка) Список идентификаторов ключей API, которые нужно удалить из кэша ключей API, разделенные запятыми. Для удаления всех ключей API используйте *. Другие шаблоны подстановок не поддерживаются.

Примеры

API для очистки кэша ключей API удаляет записи из кэша ключей API. Например, чтобы очистить запись для ключа API с идентификатором yVGMr3QByxdh1MSaicYx.

resp = client.security.clear_api_key_cache(
    ids="yVGMr3QByxdh1MSaicYx",
)
print(resp)

const response = await client.security.clearApiKeyCache({
  ids: "yVGMr3QByxdh1MSaicYx",
});
console.log(response);

POST /_security/api_key/yVGMr3QByxdh1MSaicYx/_clear_cache

Укажите несколько ключей API в виде списка, разделенного запятыми.

resp = client.security.clear_api_key_cache(
    ids="yVGMr3QByxdh1MSaicYx,YoiMaqREw0YVpjn40iMg",
)
print(resp)

const response = await client.security.clearApiKeyCache({
  ids: "yVGMr3QByxdh1MSaicYx,YoiMaqREw0YVpjn40iMg",
});
console.log(response);

POST /_security/api_key/yVGMr3QByxdh1MSaicYx,YoiMaqREw0YVpjn40iMg/_clear_cache

Чтобы очистить все записи из кэша ключей API, используйте *.

resp = client.security.clear_api_key_cache(
    ids="*",
)
print(resp)

const response = await client.security.clearApiKeyCache({
  ids: "*",
});
console.log(response);

POST /_security/api_key/*/_clear_cache

© 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/security-api-clear-api-key-cache.html