Spec-Zone.ru › Elasticsearch 8
›Elasticsearch Guide [8.17] ›REST API ›API правил запросов

Получение правила запроса

Справочник по новым API

Для получения самых актуальных данных API, обратитесь к API правил запросов.

Возвращает информацию об отдельном правиле запроса в наборе правил запросов.

Запрос

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 извлекается правило запроса с идентификатором 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"
        ]
    }
}

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-query-rule.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API