获取查询规则

编辑

检索查询规则集中单个查询规则的相关信息。

请求

编辑

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

前提条件

编辑

需要 manage_search_query_rules 权限。

路径参数

编辑
<ruleset_id>
(必需,字符串)
<rule_id>
(必需,字符串)

响应代码

编辑
400
缺少 ruleset_idrule_id,或两者都缺少。
404(缺少资源)
找不到与 ruleset_id 匹配的查询规则集,或者在该规则集中找不到与 rule_id 匹配的规则。

示例

编辑

以下示例从名为 my-ruleset 的规则集中获取 ID 为 my-rule1 的查询规则

resp = client.query_rules.get_rule(
    ruleset_id="my-ruleset",
    rule_id="my-rule1",
)
print(resp)
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"
        ]
    }
}