› › ›

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

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

Запрос

GET /<index>/_ccr/info

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

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

Описание

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

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

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

Тело ответа

follower_indices

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

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

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

parameters

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

Свойства parameters

max_outstanding_read_requests: (длинное целое) Максимальное количество ожидающих запросов чтения из удалённого кластера.
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.

Примеры

В этом примере показан запрос информации о фолловере:

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/7.17/ccr-get-follow-info.html