健康 API

GET /_health_report

GET /_health_report/<indicator>

健康 API 返回一份包含 Elasticsearch 集群健康状态的报告。该报告包含构成 Elasticsearch 功能的一系列指标。

每个指标的健康状态为：green、unknown、yellow 或 red。该指标将提供说明和元数据，描述其当前健康状态的原因。

集群的状态由最差的指标状态控制。

如果指标的状态非绿色，则指标结果中可能会存在一系列影响，详细说明健康问题对功能的负面影响。每个影响都带有严重级别、受影响的系统区域以及对系统影响的简单描述。

某些健康指标可以确定健康问题的根本原因，并规定可以执行的一系列步骤来改善系统的健康状况。根本原因和修复步骤封装在 diagnosis 中。诊断包含详细说明根本原因分析的 cause、包含修复问题步骤的简要描述的 action、受影响资源列表（如果适用）以及修复已诊断问题的详细分步故障排除指南。

resp = client.health_report()
print(resp)

response = client.health_report
puts response

const response = await client.healthReport();
console.log(response);

GET _health_report

API 返回包含所有指标的响应，无论其当前状态如何。

resp = client.health_report(
    feature="shards_availability",
)
print(resp)

response = client.health_report(
  feature: 'shards_availability'
)
puts response

const response = await client.healthReport({
  feature: "shards_availability",
});
console.log(response);

GET _health_report/shards_availability

API 仅返回分片可用性指标的响应。

resp = client.health_report(
    verbose=False,
)
print(resp)

response = client.health_report(
  verbose: false
)
puts response

const response = await client.healthReport({
  verbose: "false",
});
console.log(response);

GET _health_report?verbose=false

API 返回包含所有健康指标的响应，但不会计算响应的详细信息或根本原因分析。如果您想监控健康 API 并且不希望每次调用都计算额外的故障排除详细信息的开销，这将很有帮助。