This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
Get query ruleset
editGet query ruleset
editRetrieves information about a query ruleset.
Request
editGET _query_rules/<ruleset_id>
Prerequisites
editRequires the manage_search_query_rules privilege.
Path parameters
edit-
<ruleset_id> - (Required, string)
Response codes
edit-
400 -
The
ruleset_idwas not provided. -
404(Missing resources) -
No query ruleset matching
ruleset_idcould be found.
Examples
editThe following example gets the query ruleset named my-ruleset:
resp = client.query_rules.get_ruleset(
ruleset_id="my-ruleset",
)
print(resp)
const response = await client.transport.request({
method: "GET",
path: "/_query_rules/my-ruleset",
});
console.log(response);
GET _query_rules/my-ruleset/
A sample response:
{
"ruleset_id": "my-ruleset",
"rules": [
{
"rule_id": "my-rule1",
"type": "pinned",
"criteria": [
{
"type": "contains",
"metadata": "query_string",
"values": [ "pugs", "puggles" ]
}
],
"actions": {
"ids": [
"id1",
"id2"
]
}
},
{
"rule_id": "my-rule2",
"type": "pinned",
"criteria": [
{
"type": "fuzzy",
"metadata": "query_string",
"values": [ "rescue dogs" ]
}
],
"actions": {
"docs": [
{
"_index": "index1",
"_id": "id3"
},
{
"_index": "index2",
"_id": "id4"
}
]
}
}
]
}