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

キャッシュクリアAPI

ユーザーキャッシュからユーザーを排除します。キャッシュを完全にクリアするか、特定のユーザーを排除することができます。

リクエスト

POST /_security/realm/<realms>/_clear_cache

POST /_security/realm/<realms>/_clear_cache?usernames=<usernames>

説明

ユーザーの資格情報は、リモート認証サービスに接続したり、すべての受信リクエストのためにディスクにアクセスしたりするのを避けるために、各ノードのメモリにキャッシュされます。ユーザーキャッシュを構成するために使用できるレルム設定があります。詳細については、ユーザーキャッシュの制御を参照してください。

ロールキャッシュからロールを排除するには、ロールキャッシュクリアAPIを参照してください。特権キャッシュから特権を排除するには、特権キャッシュクリアAPIを参照してください。APIキーキャッシュからAPIキーを排除するには、APIキーキャッシュクリアAPIを参照してください。

パスパラメータ

• <realms>
• (必須、文字列) クリアするレルムのカンマ区切りリスト。すべてのレルムをクリアするには、*を使用します。他のワイルドカードパターンはサポートされていません。
• usernames
• (オプション、リスト) キャッシュからクリアするユーザーのカンマ区切りリスト。 このパラメータを指定しない場合、APIはユーザーキャッシュからすべてのユーザーを排除します。

例

たとえば、fileレルムによってキャッシュされたすべてのユーザーを排除するには:

Python

resp = client.security.clear_cached_realms(
   realms="default_file",
)
print(resp)

Js

const response = await client.security.clearCachedRealms({
  realms: "default_file",
});
console.log(response);

コンソール

POST /_security/realm/default_file/_clear_cache

選択したユーザーを排除するには、usernamesパラメータを指定します:

Python

resp = client.security.clear_cached_realms(
   realms="default_file",
   usernames="rdeniro,alpacino",
)
print(resp)

Js

const response = await client.security.clearCachedRealms({
  realms: "default_file",
  usernames: "rdeniro,alpacino",
});
console.log(response);

コンソール

POST /_security/realm/default_file/_clear_cache?usernames=rdeniro,alpacino

複数のレルムのキャッシュをクリアするには、レルムをカンマ区切りのリストとして指定します:

Python

resp = client.security.clear_cached_realms(
   realms="default_file,ldap1",
)
print(resp)

Js

const response = await client.security.clearCachedRealms({
  realms: "default_file,ldap1",
});
console.log(response);

コンソール

POST /_security/realm/default_file,ldap1/_clear_cache

すべてのレルムのキャッシュをクリアするには、*を使用します。

Python

resp = client.security.clear_cached_realms(
   realms="*",
)
print(resp)

Js

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

コンソール

POST /_security/realm/*/_clear_cache