フィルターを取得（Get filters）

フィルターAPIの取得

フィルターを取得します。

リクエスト

GET _ml/filters/<filter_id>

GET _ml/filters/

前提条件

manage_ml クラスター権限が必要です。この権限は machine_learning_admin ビルトインロールに含まれています。

説明

単一のフィルターまたはすべてのフィルターを取得できます。詳細については、カスタムルールを参照してください。

パスパラメータ

• <filter_id>
• （オプション、文字列）フィルターを一意に識別する文字列。

クエリパラメータ

• from
• （オプション、整数）指定された数のフィルターをスキップします。デフォルトは 0 です。
• size
• （オプション、整数）取得するフィルターの最大数を指定します。デフォルトは 100 です。

レスポンスボディ

APIはフィルターリソースの配列を返します。これには以下のプロパティがあります：

• description
• （文字列）フィルターの説明。
• filter_id
• （文字列）フィルターを一意に識別する文字列。
• items
• （文字列の配列）フィルターアイテムリストの文字列の配列。

例

Python

resp = client.ml.get_filters(
   filter_id="safe_domains",
)
print(resp)

Ruby

response = client.ml.get_filters(
  filter_id: 'safe_domains'
)
puts response

Js

const response = await client.ml.getFilters({
  filter_id: "safe_domains",
});
console.log(response);

コンソール

GET _ml/filters/safe_domains

APIは以下の結果を返します：

コンソール-結果

{
  "count": 1,
  "filters": [
   {
   "filter_id": "safe_domains",
   "description": "A list of safe domains",
   "items": [
   "*.google.com",
   "wikipedia.org"
   ]
   }
  ]
}