› › ›

API возобновления фолловера

Возобновляет индекс фолловера кросс-кластерной репликации.

Запрос

resp = client.ccr.resume_follow(
    index="<follower_index>",
)
print(resp)

const response = await client.ccr.resumeFollow({
  index: "<follower_index>",
});
console.log(response);

POST /<follower_index>/_ccr/resume_follow
{
}

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

Если включены функции безопасности Elasticsearch, у вас должны быть write и monitor права доступа к индексу фолловера. У вас должны быть read и monitor права доступа к индексу лидера. У вас также должны быть manage_ccr права доступа к кластеру, содержащему индекс фолловера. Дополнительную информацию см. в разделе Права доступа к безопасности.

Описание

Этот API возобновляет индекс фолловера, который был приостановлен явно с помощью API приостановки фолловера или неявно из-за выполнения, которое не может быть повторно выполнено из-за сбоя при слежении. После возврата этого API индекс фолловера возобновит извлечение операций из индекса лидера.

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

<follower_index>: (Обязательно, строка) Название индекса фолловера.

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

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

Тело запроса

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 описывает все значения по умолчанию для параметров запроса следования индекса, описанных выше:

{
  "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"
      }
    }
  ]
}

Примеры

В этом примере возобновляется индекс фолловера с именем follower_index:

resp = client.ccr.resume_follow(
    index="follower_index",
    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",
)
print(resp)

const response = await client.ccr.resumeFollow({
  index: "follower_index",
  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",
});
console.log(response);

POST /follower_index/_ccr/resume_follow
{
  "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/8.17/ccr-post-resume-follow.html