清除 API 密钥缓存 API

编辑

从 API 密钥缓存中清除一部分条目。当安全索引的状态发生更改时,缓存也会自动清除。

请求

编辑

POST /_security/api_key/<ids>/_clear_cache

先决条件

编辑
  • 要使用此 API,您必须至少拥有 manage_security 集群权限。

描述

编辑

有关 API 密钥的更多信息,请参阅 创建 API 密钥获取 API 密钥信息使 API 密钥失效

路径参数

编辑
<ids>
(必需,字符串)要从 API 密钥缓存中清除的 API 密钥 ID 的逗号分隔列表。要清除所有 API 密钥,请使用 *。不支持其他通配符模式。

示例

编辑

清除 API 密钥缓存 API 会从 API 密钥缓存中清除条目。例如,要清除 ID 为 yVGMr3QByxdh1MSaicYx 的 API 密钥的条目。

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