APIキーキャッシュのクリア（Clear API key cache）

クリア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キーのエントリをクリアするには。

Python

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

Js

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

コンソール

POST /_security/api_key/yVGMr3QByxdh1MSaicYx/_clear_cache

複数のAPIキーをカンマ区切りリストとして指定します。

Python

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

Js

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

コンソール

POST /_security/api_key/yVGMr3QByxdh1MSaicYx,YoiMaqREw0YVpjn40iMg/_clear_cache

APIキーキャッシュからすべてのエントリをクリアするには、*を使用します。

Python

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

Js

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

コンソール

POST /_security/api_key/*/_clear_cache