› › ›

API создания шаблона авто-слежения

Создаёт шаблон авто-слежения.

Запрос

PUT /_ccr/auto_follow/<auto_follow_pattern_name>
{
  "remote_cluster" : "<remote_cluster>",
  "leader_index_patterns" :
  [
    "<leader_index_pattern>"
  ],
  "leader_index_exclusion_patterns":
  [
    "<leader_index_exclusion_pattern>"
  ],
  "follow_index_pattern" : "<follow_index_pattern>"
}

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

Если включены функции безопасности Elasticsearch, у вас должны быть read и monitor права доступа к индексам-лидерам шаблонов. Вам также необходимо иметь manage_ccr права доступа к кластеру, который содержит индекс-фолловер. Дополнительная информация находится в разделе Права доступа к безопасности.

Описание

Этот API создаёт новую именованную коллекцию шаблонов авто-слежения для удалённого кластера, указанного в теле запроса. Новые индексы на удалённом кластере, соответствующие любому из указанных шаблонов, будут автоматически настроены как индексы-фолловеры. Индексы на удалённом кластере, созданные до создания шаблона авто-слежения, не будут автоматически отслеживаться, даже если они соответствуют шаблону.

Этот API также может использоваться для обновления существующих шаблонов авто-слежения. Обратите внимание, что индексы-фолловеры, которые были автоматически настроены до обновления шаблона авто-слежения, останутся неизменными, даже если они не соответствуют новым шаблонам.

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

<auto_follow_pattern_name>: (Обязательно, строка) Имя коллекции шаблонов авто-слежения.

Тело запроса

remote_cluster: (Обязательно, строка) Удалённый кластер, содержащий индексы-лидеры, которые нужно сопоставить.
leader_index_patterns: (Необязательно, массив) Массив простых шаблонов индексов для сопоставления с индексами на удалённом кластере, указанном в поле remote_cluster.
leader_index_exclusion_patterns: (Необязательно, массив) Массив простых шаблонов индексов, которые могут использоваться для исключения индексов из авто-слежения. Индексы на удалённом кластере, имена которых соответствуют одному или нескольким leader_index_patterns и одному или нескольким leader_index_exclusion_patterns, не будут отслеживаться.
follow_index_pattern: (Необязательно, строка) Имя индекса-фолловера. Шаблон {{leader_index}} может использоваться для получения имени индекса-фолловера из имени индекса-лидера. При слежении за потоком данных используйте {{leader_index}}; CCR не поддерживает изменения имён фолловер индекса потока данных.
settings: (объект) Параметры для переопределения из индекса-лидера. Обратите внимание, что некоторые параметры не могут быть переопределены (например, index.number_of_shards).
max_read_request_operation_count: (целое число) Максимальное количество операций для извлечения за один считывание с удалённого кластера.
max_outstanding_read_requests: (длинное целое число) Максимальное количество ожидающих запросов на чтение с удалённого кластера.
max_read_request_size: (значение в байтах) Максимальный размер в байтах каждого чтения пакетной операции, извлечённой с удалённого кластера.
max_write_request_operation_count: (целое число) Максимальное количество операций на запрос по пакетному записи, выполняемый на фолловере.
max_write_request_size: (значение в байтах) Максимальное общее количество байтов операций на запрос по пакетному записи, выполняемый на фолловере.
max_outstanding_write_requests: (целое число) Максимальное количество ожидающих запросов на запись на фолловере.
max_write_buffer_count: (целое число) Максимальное количество операций, которые могут быть помещены в очередь для записи. Когда этот лимит достигнут, чтение с удалённого кластера будет отложено до тех пор, пока количество операций в очереди не опустится ниже лимита.
max_write_buffer_size: (значение в байтах) Максимальное общее количество байтов операций, которые могут быть помещены в очередь для записи. Когда этот лимит достигнут, чтение с удалённого кластера будет отложено до тех пор, пока общее количество байтов операций в очереди не опустится ниже лимита.
max_retry_delay: (значение времени) Максимальное время ожидания перед повторной попыткой операции, которая завершилась ошибкой. При повторе используется стратегия экспоненциального возврата.
read_poll_timeout: (значение времени) Максимальное время ожидания новых операций на удалённом кластере, когда индекс-фолловер синхронизирован с индексом-лидером. По истечении таймаута запрос на чтение операций вернётся фолловеру для обновления некоторых статистических данных. Затем фолловер немедленно попытается прочитать данные с лидера снова.

Значения по умолчанию

Следующий вывод из api follow info описывает все значения по умолчанию для описанных выше параметров запроса follow индекса:

{
  "follower_indices" : [
    {
      "parameters" : {
        "max_read_request_operation_count" : 5120,
        "max_read_request_size" : "32mb",
        "max_outstanding_read_requests" : 12,
        "max_write_request_operation_count" : 5120,
        "max_write_request_size" : "9223372036854775807b",
        "max_outstanding_write_requests" : 9,
        "max_write_buffer_count" : 2147483647,
        "max_write_buffer_size" : "512mb",
        "max_retry_delay" : "500ms",
        "read_poll_timeout" : "1m"
      }
    }
  ]
}

Примеры

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

PUT /_ccr/auto_follow/my_auto_follow_pattern
{
  "remote_cluster" : "remote_cluster",
  "leader_index_patterns" :
  [
    "leader_index*"
  ],
  "follow_index_pattern" : "{{leader_index}}-follower",
  "settings": {
    "index.number_of_replicas": 0
  },
  "max_read_request_operation_count" : 1024,
  "max_outstanding_read_requests" : 16,
  "max_read_request_size" : "1024k",
  "max_write_request_operation_count" : 32768,
  "max_write_request_size" : "16k",
  "max_outstanding_write_requests" : 8,
  "max_write_buffer_count" : 512,
  "max_write_buffer_size" : "512k",
  "max_retry_delay" : "10s",
  "read_poll_timeout" : "30s"
}

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

{
  "acknowledged" : true
}

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