クエリルールを取得（Get query rule）

クエリルールの取得

クエリルールセット内の個々のクエリルールに関する情報を取得します。

リクエスト

GET _query_rules/<ruleset_id>/_rule/<rule_id>

前提条件

manage_search_query_rules 権限が必要です。

パスパラメータ

• <ruleset_id>
• （必須、文字列）
• <rule_id>
• （必須、文字列）

レスポンスコード

• 400
• ruleset_id または rule_id が欠落している、または両方が欠落している。
• 404 （リソースが欠落しています）
• ruleset_id に一致するクエリルールセットが見つからないか、またはそのルールセット内で rule_id に一致するルールが見つからない。

例

以下の例は、my-ruleset という名前のルールセットから ID my-rule1 のクエリルールを取得します:

Python

resp = client.query_rules.get_rule(
   ruleset_id="my-ruleset",
   rule_id="my-rule1",
)
print(resp)

Js

const response = await client.transport.request({
  method: "GET",
  path: "/_query_rules/my-ruleset/_rule/my-rule1",
});
console.log(response);

コンソール

GET _query_rules/my-ruleset/_rule/my-rule1

サンプルレスポンス:

コンソール-結果

{
   "rule_id": "my-rule1",
   "type": "pinned",
   "criteria": [
   {
   "type": "contains",
   "metadata": "query_string",
   "values": [ "pugs", "puggles" ]
   }
   ],
   "actions": {
   "ids": [
   "id1",
   "id2"
   ]
   }
}