› › ›

API получения информации о фолловерах

Получает информацию обо всех фолловерах репликации между кластерами.

Запрос

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

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

GET /<index>/_ccr/info

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

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

Описание

Этот API перечисляет параметры и состояние каждого фолловера. Например, в результатах содержатся имена фолловеров, имена лидеров, параметры репликации и активность/пауза фолловеров.

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

<index>: (Обязательный, строка) Список шаблонов фолловеров, разделённых запятыми.

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

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

Тело ответа

follower_indices

(массив) Массив статистических данных фолловеров.

Свойства объектов в follower_indices

follower_index: (строка) Имя фолловера.
leader_index: (строка) Имя индекса лидера, за которым ведётся слежение.

parameters

(объект) Объект, содержащий параметры репликации между кластерами. Если статус фолловера status установлен на paused, этот объект опущен.

Свойства parameters

max_outstanding_read_requests: (long) Максимальное количество ожидающих запросов чтения из удалённого кластера.
max_outstanding_write_requests: (целое число) Максимальное количество ожидающих запросов записи на фолловере.
max_read_request_operation_count: (целое число) Максимальное количество операций для извлечения за один запрос чтения из удалённого кластера.
max_read_request_size: (значение байтов) Максимальный размер в байтах за один запрос чтения блока операций, извлечённых из удалённого кластера.
max_retry_delay: (значение времени) Максимальное время ожидания перед повторной попыткой операции, которая завершилась ошибкой. При повторных попытках используется стратегия экспоненциального замедления.
max_write_buffer_count: (целое число) Максимальное количество операций, которые могут быть помещены в очередь для записи. Когда этот лимит достигнут, чтение из удалённого кластера откладывается до тех пор, пока количество операций в очереди не станет ниже лимита.
max_write_buffer_size: (значение байтов) Максимальное общее количество байтов операций, которые могут быть помещены в очередь для записи. Когда этот лимит достигнут, чтение из удалённого кластера откладывается до тех пор, пока общее количество байтов в очереди не станет ниже лимита.
max_write_request_operation_count: (целое число) Максимальное количество операций в запросе пакетной записи, выполняемых на фолловере.
max_write_request_size: (значение байтов) Максимальное общее количество байтов операций в запросе пакетной записи, выполняемых на фолловере.
read_poll_timeout: (значение времени) Максимальное время ожидания новых операций в удалённом кластере, когда индекс фолловера синхронизирован с индексом лидера. По истечении таймаута, запрос на получение операций возвращается фолловеру для обновления статистики, затем фоллвер снова пытается прочитать данные из лидера.

remote_cluster

(строка) удаленный кластер, содержащий индекс лидера.

status

(строка) Статус слежения за индексом: active или paused.

Примеры

Этот пример получает информацию о фолловерах:

resp = client.ccr.follow_info(
    index="follower_index",
)
print(resp)

response = client.ccr.follow_info(
  index: 'follower_index'
)
puts response

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

GET /follower_index/_ccr/info

Если индекс фолловера active, API возвращает следующие результаты:

{
  "follower_indices": [
    {
      "follower_index": "follower_index",
      "remote_cluster": "remote_cluster",
      "leader_index": "leader_index",
      "status": "active",
      "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"
      }
    }
  ]
}

Если индекс фолловера paused, API возвращает следующие результаты:

{
  "follower_indices": [
    {
      "follower_index": "follower_index",
      "remote_cluster": "remote_cluster",
      "leader_index": "leader_index",
      "status": "paused"
    }
  ]
}

© 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-follow-info.html