索引恢复 API
编辑索引恢复 API编辑
返回有关一个或多个索引的正在进行和已完成的碎片恢复的信息。对于数据流，API 返回有关流的备份索引的信息。
response = client.indices.recovery( index: 'my-index-000001' ) puts response
GET /my-index-000001/_recovery
描述编辑
使用索引恢复 API 获取有关正在进行和已完成的碎片恢复的信息。
碎片恢复是初始化碎片副本的过程，例如从快照恢复主碎片或从主碎片同步副本碎片。当碎片恢复完成时，恢复的碎片可用于搜索和索引。
恢复会在以下过程中自动发生
索引恢复 API 仅报告有关当前存在于集群中的碎片副本的已完成恢复的信息。它只报告每个碎片副本的最后一次恢复，不报告有关早期恢复的历史信息，也不报告有关不再存在的碎片副本的恢复信息。这意味着，如果碎片副本完成恢复，然后 Elasticsearch 将其重新分配到另一个节点，则恢复 API 中不会显示有关原始恢复的信息。
路径参数编辑
-
<target> - (可选，字符串) 用于限制请求的数据流、索引和别名的逗号分隔列表。支持通配符 (
*)。要针对所有数据流和索引，请省略此参数或使用*或_all。
查询参数编辑
-
active_only - (可选，布尔值) 如果为
true，则响应仅包含正在进行的碎片恢复。默认为false。 -
detailed - (可选，布尔值) 如果为
true，则响应包含有关碎片恢复的详细信息。默认为false。 -
index - (可选，字符串) 用于限制请求的索引名称的逗号分隔列表或通配符表达式。
响应主体编辑
-
id - (整数) 碎片的 ID。
-
type -
(字符串) 碎片的恢复源。返回的值包括
-
EMPTY_STORE - 空存储。表示新的主碎片或使用 集群重新路由 API 强制分配空主碎片。
-
EXISTING_STORE - 现有主碎片的存储。表示恢复与节点启动或现有主碎片的分配相关。
-
LOCAL_SHARDS - 同一节点上另一个索引的碎片。表示恢复与 克隆、缩减 或 拆分 操作相关。
-
PEER - 另一个节点上的主碎片。表示恢复与碎片复制相关。
-
SNAPSHOT - 快照。表示恢复与 恢复快照 操作相关。
-
-
STAGE -
(字符串) 恢复阶段。返回的值可能包括
-
INIT - 恢复尚未开始。
-
INDEX - 读取索引元数据并将字节从源复制到目标。
-
VERIFY_INDEX - 验证索引的完整性。
-
TRANSLOG - 重播事务日志。
-
FINALIZE - 清理。
-
DONE - 完成。
-
-
primary - (布尔值) 如果为
true，则碎片为主碎片。 -
start_time - (字符串) 恢复开始的时间戳。
-
stop_time - (字符串) 恢复完成的时间戳。
-
total_time_in_millis - (字符串) 恢复碎片的总时间（毫秒）。
-
source -
(对象) 恢复源。这可能包括
- 如果从快照恢复，则为存储库描述
- 源节点的描述
-
target - (对象) 目标节点。
-
index - (对象) 有关物理索引恢复的统计信息。
-
translog - (对象) 有关事务日志恢复的统计信息。
-
start - (对象) 有关打开和启动索引的时间的统计信息。
示例编辑
获取多个数据流和索引的恢复信息编辑
response = client.indices.recovery( index: 'index1,index2', human: true ) puts response
GET index1,index2/_recovery?human
获取集群中所有数据流和索引的段信息编辑
response = client.indices.recovery( human: true ) puts response
GET /_recovery?human
API 返回以下响应
{
"index1" : {
"shards" : [ {
"id" : 0,
"type" : "SNAPSHOT",
"stage" : "INDEX",
"primary" : true,
"start_time" : "2014-02-24T12:15:59.716",
"start_time_in_millis": 1393244159716,
"stop_time" : "0s",
"stop_time_in_millis" : 0,
"total_time" : "2.9m",
"total_time_in_millis" : 175576,
"source" : {
"repository" : "my_repository",
"snapshot" : "my_snapshot",
"index" : "index1",
"version" : "{version}",
"restoreUUID": "PDh1ZAOaRbiGIVtCvZOMww"
},
"target" : {
"id" : "ryqJ5lO5S4-lSFbGntkEkg",
"host" : "my.fqdn",
"transport_address" : "my.fqdn",
"ip" : "10.0.1.7",
"name" : "my_es_node"
},
"index" : {
"size" : {
"total" : "75.4mb",
"total_in_bytes" : 79063092,
"reused" : "0b",
"reused_in_bytes" : 0,
"recovered" : "65.7mb",
"recovered_in_bytes" : 68891939,
"recovered_from_snapshot" : "0b",
"recovered_from_snapshot_in_bytes" : 0,
"percent" : "87.1%"
},
"files" : {
"total" : 73,
"reused" : 0,
"recovered" : 69,
"percent" : "94.5%"
},
"total_time" : "0s",
"total_time_in_millis" : 0,
"source_throttle_time" : "0s",
"source_throttle_time_in_millis" : 0,
"target_throttle_time" : "0s",
"target_throttle_time_in_millis" : 0
},
"translog" : {
"recovered" : 0,
"total" : 0,
"percent" : "100.0%",
"total_on_start" : 0,
"total_time" : "0s",
"total_time_in_millis" : 0
},
"verify_index" : {
"check_index_time" : "0s",
"check_index_time_in_millis" : 0,
"total_time" : "0s",
"total_time_in_millis" : 0
}
} ]
}
}
此响应包含有关单个索引恢复单个碎片的信息。恢复的来源是快照存储库，恢复的目标是 my_es_node 节点。
响应还包括恢复的文件和字节数以及百分比。
获取详细的恢复信息编辑
要获取恢复中物理文件的列表，请将 detailed 查询参数设置为 true。
response = client.indices.recovery( human: true, detailed: true ) puts response
GET _recovery?human&detailed=true
API 返回以下响应
{
"index1" : {
"shards" : [ {
"id" : 0,
"type" : "STORE",
"stage" : "DONE",
"primary" : true,
"start_time" : "2014-02-24T12:38:06.349",
"start_time_in_millis" : "1393245486349",
"stop_time" : "2014-02-24T12:38:08.464",
"stop_time_in_millis" : "1393245488464",
"total_time" : "2.1s",
"total_time_in_millis" : 2115,
"source" : {
"id" : "RGMdRc-yQWWKIBM4DGvwqQ",
"host" : "my.fqdn",
"transport_address" : "my.fqdn",
"ip" : "10.0.1.7",
"name" : "my_es_node"
},
"target" : {
"id" : "RGMdRc-yQWWKIBM4DGvwqQ",
"host" : "my.fqdn",
"transport_address" : "my.fqdn",
"ip" : "10.0.1.7",
"name" : "my_es_node"
},
"index" : {
"size" : {
"total" : "24.7mb",
"total_in_bytes" : 26001617,
"reused" : "24.7mb",
"reused_in_bytes" : 26001617,
"recovered" : "0b",
"recovered_in_bytes" : 0,
"recovered_from_snapshot" : "0b",
"recovered_from_snapshot_in_bytes" : 0,
"percent" : "100.0%"
},
"files" : {
"total" : 26,
"reused" : 26,
"recovered" : 0,
"percent" : "100.0%",
"details" : [ {
"name" : "segments.gen",
"length" : 20,
"recovered" : 20
}, {
"name" : "_0.cfs",
"length" : 135306,
"recovered" : 135306,
"recovered_from_snapshot": 0
}, {
"name" : "segments_2",
"length" : 251,
"recovered" : 251,
"recovered_from_snapshot": 0
}
]
},
"total_time" : "2ms",
"total_time_in_millis" : 2,
"source_throttle_time" : "0s",
"source_throttle_time_in_millis" : 0,
"target_throttle_time" : "0s",
"target_throttle_time_in_millis" : 0
},
"translog" : {
"recovered" : 71,
"total" : 0,
"percent" : "100.0%",
"total_on_start" : 0,
"total_time" : "2.0s",
"total_time_in_millis" : 2025
},
"verify_index" : {
"check_index_time" : 0,
"check_index_time_in_millis" : 0,
"total_time" : "88ms",
"total_time_in_millis" : 88
}
} ]
}
}
响应包含恢复的任何物理文件的列表及其大小。
响应还包括恢复各个阶段的时间（毫秒）
- 索引检索
- 事务日志重播
- 索引启动时间
此响应表示恢复已 完成。所有恢复（无论正在进行还是已完成）都保存在集群状态中，并且可以随时报告。
要仅返回有关正在进行的恢复的信息，请将 active_only 查询参数设置为 true。