› › ›

API получения шаблонов авто-слежения

Получение шаблонов авто-слежения для кросс-кластерной репликации.

Запрос

resp = client.ccr.get_auto_follow_pattern()
print(resp)

response = client.ccr.get_auto_follow_pattern
puts response

const response = await client.ccr.getAutoFollowPattern();
console.log(response);

GET /_ccr/auto_follow/

resp = client.ccr.get_auto_follow_pattern(
    name="<auto_follow_pattern_name>",
)
print(resp)

const response = await client.ccr.getAutoFollowPattern({
  name: "<auto_follow_pattern_name>",
});
console.log(response);

GET /_ccr/auto_follow/<auto_follow_pattern_name>

Предварительные условия

Если включены функции безопасности Elasticsearch, у вас должны быть manage_ccr привилегии кластера на кластере, содержащем индекс-фолловера. Дополнительную информацию см. в разделе Безопасность: привилегии.

Описание

Этот API получает настроенные шаблоны авто-слежения. Этот API вернёт указанную коллекцию шаблонов авто-слежения.

Параметры пути

<auto_follow_pattern_name>: (Необязательно, строка) Указывает коллекцию шаблонов авто-слежения, которую вы хотите получить. Если вы не укажете имя, API вернёт информацию обо всех коллекциях.

Параметры запроса

master_timeout: (Необязательно, единицы измерения времени) Период ожидания для узла-мастера. Если узел-мастер недоступен до истечения таймаута, запрос завершится ошибкой. По умолчанию 30s. Также может быть установлен на -1, чтобы указать, что запрос никогда не должен таймаутиться.

Примеры

В этом примере извлекается информация о коллекции шаблонов авто-слежения с именем my_auto_follow_pattern:

resp = client.ccr.get_auto_follow_pattern(
    name="my_auto_follow_pattern",
)
print(resp)

response = client.ccr.get_auto_follow_pattern(
  name: 'my_auto_follow_pattern'
)
puts response

const response = await client.ccr.getAutoFollowPattern({
  name: "my_auto_follow_pattern",
});
console.log(response);

GET /_ccr/auto_follow/my_auto_follow_pattern

API возвращает следующий результат:

{
  "patterns": [
    {
      "name": "my_auto_follow_pattern",
      "pattern": {
        "active": true,
        "remote_cluster" : "remote_cluster",
        "leader_index_patterns" :
        [
          "leader_index*"
        ],
        "leader_index_exclusion_patterns":
        [
          "leader_index_001"
        ],
        "follow_index_pattern" : "{{leader_index}}-follower"
      }
    }
  ]
}

© 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/ccr-get-auto-follow-pattern.html