エンリッチポリシーの取得（Get enrich policy）

エンリッチポリシーAPIの取得

エンリッチポリシーに関する情報を返します。enrich policy。

Python

resp = client.enrich.get_policy(
   name="my-policy",
)
print(resp)

Ruby

response = client.enrich.get_policy(
  name: 'my-policy'
)
puts response

Js

const response = await client.enrich.getPolicy({
  name: "my-policy",
});
console.log(response);

コンソール

GET /_enrich/policy/my-policy

リクエスト

GET /_enrich/policy/<name>

GET /_enrich/policy

GET /_enrich/policy/policy1,policy2

前提条件

エンリッチポリシーを使用するには、次の条件を満たす必要があります：

• read インデックスの権限が必要です
• enrich_user 組み込みロール

パスパラメータ

• <name>
• （オプション、文字列）リクエストを制限するために使用されるエンリッチポリシー名のカンマ区切りリスト。
  すべてのエンリッチポリシーの情報を返すには、このパラメータを省略してください。

例

単一ポリシーの取得

Python

resp = client.enrich.get_policy(
   name="my-policy",
)
print(resp)

Ruby

response = client.enrich.get_policy(
  name: 'my-policy'
)
puts response

Js

const response = await client.enrich.getPolicy({
  name: "my-policy",
});
console.log(response);

コンソール

GET /_enrich/policy/my-policy

APIは次のレスポンスを返します：

コンソール-結果

{
  "policies": [
   {
   "config": {
   "match": {
   "name": "my-policy",
   "indices": [ "users" ],
   "match_field": "email",
   "enrich_fields": [
   "first_name",
   "last_name",
   "city",
   "zip",
   "state"
   ]
   }
   }
   }
  ]
}

複数ポリシーの取得

Python

resp = client.enrich.get_policy(
   name="my-policy,other-policy",
)
print(resp)

Ruby

response = client.enrich.get_policy(
  name: 'my-policy,other-policy'
)
puts response

Js

const response = await client.enrich.getPolicy({
  name: "my-policy,other-policy",
});
console.log(response);

コンソール

GET /_enrich/policy/my-policy,other-policy

APIは次のレスポンスを返します：

コンソール-結果

{
  "policies": [
   {
   "config": {
   "match": {
   "name": "my-policy",
   "indices": [ "users" ],
   "match_field": "email",
   "enrich_fields": [
   "first_name",
   "last_name",
   "city",
   "zip",
   "state"
   ]
   }
   }
   },
   {
   "config": {
   "match": {
   "name": "other-policy",
   "indices": [ "users" ],
   "match_field": "email",
   "enrich_fields": [
   "first_name",
   "last_name",
   "city",
   "zip",
   "state"
   ]
   }
   }
   }
  ]
}

すべてのポリシーの取得

Python

resp = client.enrich.get_policy()
print(resp)

Ruby

response = client.enrich.get_policy
puts response

Js

const response = await client.enrich.getPolicy();
console.log(response);

コンソール

GET /_enrich/policy

APIは次のレスポンスを返します：

コンソール-結果

{
  "policies": [
   {
   "config": {
   "match": {
   "name": "my-policy",
   "indices": [ "users" ],
   "match_field": "email",
   "enrich_fields": [
   "first_name",
   "last_name",
   "city",
   "zip",
   "state"
   ]
   }
   }
   },
   {
   "config": {
   "match": {
   "name": "other-policy",
   "indices": [ "users" ],
   "match_field": "email",
   "enrich_fields": [
   "first_name",
   "last_name",
   "city",
   "zip",
   "state"
   ]
   }
   }
   }
  ]
}