› › ›

API cat recovery

API cat предназначены только для использования человеком через командную строку или консоль Kibana. Они не предназначены для использования приложениями. Для использования приложениями используйте API восстановления индекса.

Возвращает информацию о текущем и завершенном восстановлении фрагментов, аналогично API восстановления индекса.

Для потоков данных API возвращает информацию об индексах, на которых базируется поток.

Запрос

GET /_cat/recovery/<target>

GET /_cat/recovery

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

Если включены функции безопасности Elasticsearch, у вас должны быть monitor или manage права доступа к кластеру для использования этого API. Вы также должны иметь monitor или manage права доступа к индексам для любого потока данных, индекса или псевдонима, который вы получаете.

Описание

API cat recovery возвращает информацию о восстановлении фрагментов, как текущих, так и завершенных. Это более компактный вид JSON API восстановления индекса.

Восстановление фрагмента — это процесс синхронизации фрагмента реплики с фрагментом первичного источника. После завершения фрагмент реплики доступен для поиска.

Восстановление автоматически происходит во время следующих процессов:

Запуск узла. Этот тип восстановления называется восстановлением локального хранилища.
Репликация первичного фрагмента.
Перемещение фрагмента на другой узел в том же кластере.
Операция восстановления снимка.
Операции клонирования, уменьшения или разделения индекса.

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

<target>: (Необязательно, строка) Список потоков данных, индексов и псевдонимов, разделенных запятыми, используемый для ограничения запроса. Поддерживаются шаблоны (*). Для задания всех потоков данных и индексов опустите этот параметр или используйте * или _all.

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

active_only: (Необязательно, логическое значение) Если true, в ответе содержатся только текущие восстановления фрагментов. По умолчанию false.
bytes: (Необязательно, единицы измерения размера байтов) Единица измерения для отображения значений байтов.
detailed: (Необязательно, логическое значение) Если true, ответ включает подробную информацию о восстановлении фрагментов. По умолчанию false.
format: (Необязательно, строка) Короткая версия заголовка HTTP accept. Допустимые значения: JSON, YAML и т.д.
h: (Необязательно, строка) Список имен столбцов, разделенных запятыми, для отображения.
help: (Необязательно, логическое значение) Если true, ответ включает справочную информацию. По умолчанию false.
index: (Необязательно, строка) Список имен индексов, разделенных запятыми, или выражение с подстановкой для ограничения запроса.
s: (Необязательно, строка) Список имен столбцов, разделенных запятыми, или псевдонимы столбцов для сортировки ответа.
time: (Необязательно, единицы измерения времени) Единица измерения для отображения значений времени.
v: (Необязательно, логическое значение) Если true, ответ включает заголовки столбцов. По умолчанию false.

Примеры

Пример без текущих восстановлений

GET _cat/recovery?v=true

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

index             shard time type  stage source_host source_node target_host target_node repository snapshot files files_recovered files_percent files_total bytes bytes_recovered bytes_percent bytes_total translog_ops translog_ops_recovered translog_ops_percent
my-index-000001   0     13ms store done  n/a         n/a         127.0.0.1   node-0      n/a        n/a      0     0               100%          13          0     0               100%          9928        0            0                      100.0%

В этом примере ответа исходные и целевые узлы совпадают, потому что тип восстановления — store, что означает чтение из локального хранилища при запуске узла.

Пример с текущим восстановлением фрагмента

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

GET _cat/recovery?v=true&h=i,s,t,ty,st,shost,thost,f,fp,b,bp

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

i               s t      ty   st    shost       thost       f     fp      b bp
my-index-000001 0 1252ms peer done  192.168.1.1 192.168.1.2 0     100.0%  0 100.0%

В этом примере ответа тип восстановления — peer, что означает восстановление фрагмента с другого узла. Возвращаемые файлы и байты — это измерения в реальном времени.

Пример восстановления снимка

Вы можете восстановить резервные копии индекса с помощью API снимков и восстановления. Вы можете использовать API cat recovery, чтобы получить информацию о восстановлении снимка.

GET _cat/recovery?v=true&h=i,s,t,ty,st,rep,snap,f,fp,b,bp

API возвращает следующий ответ с типом восстановления snapshot:

i               s t      ty       st    rep     snap   f  fp   b     bp
my-index-000001 0 1978ms snapshot done  my-repo snap_1 79 8.0% 12086 9.0%

© 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/cat-recovery.html