Get the cluster health
Added in 8.7.0
Get a report with the health status of an Elasticsearch cluster. The report contains a list of indicators that compose Elasticsearch functionality.
Each indicator has a health status of: green, unknown, yellow or red. The indicator will provide an explanation and metadata describing the reason for its current health status.
The cluster’s status is controlled by the worst indicator status.
In the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue. Each impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system.
Some health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system. The root cause and remediation steps are encapsulated in a diagnosis. A diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem.
NOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently. When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic.
Responses
-
200 application/json
Hide response attributes Show response attributes object
-
cluster_name
string Required -
indicators
object Required Additional properties are allowed.
Hide indicators attributes Show indicators attributes object
-
master_is_stable
object Additional properties are allowed.
Hide master_is_stable attributes Show master_is_stable attributes object
-
status
string Required Values are
green
,yellow
,red
, orunknown
. -
symptom
string Required -
impacts
array[object] Hide impacts attributes Show impacts attributes object
-
description
string Required -
id
string Required -
impact_areas
array[string] Required Values are
search
,ingest
,backup
, ordeployment_management
. -
severity
number Required
-
-
diagnosis
array[object] Hide diagnosis attributes Show diagnosis attributes object
-
id
string Required -
action
string Required -
affected_resources
object Required Additional properties are allowed.
-
cause
string Required -
help_url
string Required
-
-
details
object Additional properties are allowed.
Hide details attributes Show details attributes object
-
current_master
object Required Additional properties are allowed.
-
recent_masters
array[object] Required Additional properties are allowed.
-
exception_fetching_history
object Additional properties are allowed.
Hide exception_fetching_history attributes Show exception_fetching_history attributes object
-
message
string Required -
stack_trace
string Required
-
-
cluster_formation
array[object] Additional properties are allowed.
-
-
-
shards_availability
object Additional properties are allowed.
Hide shards_availability attributes Show shards_availability attributes object
-
status
string Required Values are
green
,yellow
,red
, orunknown
. -
symptom
string Required -
impacts
array[object] Hide impacts attributes Show impacts attributes object
-
description
string Required -
id
string Required -
impact_areas
array[string] Required Values are
search
,ingest
,backup
, ordeployment_management
. -
severity
number Required
-
-
diagnosis
array[object] Hide diagnosis attributes Show diagnosis attributes object
-
id
string Required -
action
string Required -
affected_resources
object Required Additional properties are allowed.
-
cause
string Required -
help_url
string Required
-
-
details
object Additional properties are allowed.
Hide details attributes Show details attributes object
-
creating_primaries
number Required -
creating_replicas
number Required -
initializing_primaries
number Required -
initializing_replicas
number Required -
restarting_primaries
number Required -
restarting_replicas
number Required -
started_primaries
number Required -
started_replicas
number Required -
unassigned_primaries
number Required -
unassigned_replicas
number Required
-
-
-
disk
object Additional properties are allowed.
Hide disk attributes Show disk attributes object
-
status
string Required Values are
green
,yellow
,red
, orunknown
. -
symptom
string Required -
impacts
array[object] Hide impacts attributes Show impacts attributes object
-
description
string Required -
id
string Required -
impact_areas
array[string] Required Values are
search
,ingest
,backup
, ordeployment_management
. -
severity
number Required
-
-
diagnosis
array[object] Hide diagnosis attributes Show diagnosis attributes object
-
id
string Required -
action
string Required -
affected_resources
object Required Additional properties are allowed.
-
cause
string Required -
help_url
string Required
-
-
details
object Additional properties are allowed.
Hide details attributes Show details attributes object
-
indices_with_readonly_block
number Required -
nodes_with_enough_disk_space
number Required -
nodes_over_high_watermark
number Required -
nodes_over_flood_stage_watermark
number Required -
nodes_with_unknown_disk_status
number Required
-
-
-
repository_integrity
object Additional properties are allowed.
Hide repository_integrity attributes Show repository_integrity attributes object
-
status
string Required Values are
green
,yellow
,red
, orunknown
. -
symptom
string Required -
impacts
array[object] Hide impacts attributes Show impacts attributes object
-
description
string Required -
id
string Required -
impact_areas
array[string] Required Values are
search
,ingest
,backup
, ordeployment_management
. -
severity
number Required
-
-
diagnosis
array[object] Hide diagnosis attributes Show diagnosis attributes object
-
id
string Required -
action
string Required -
affected_resources
object Required Additional properties are allowed.
-
cause
string Required -
help_url
string Required
-
-
details
object Additional properties are allowed.
Hide details attributes Show details attributes object
-
total_repositories
number -
corrupted_repositories
number -
corrupted
array[string]
-
-
-
data_stream_lifecycle
object Additional properties are allowed.
Hide data_stream_lifecycle attributes Show data_stream_lifecycle attributes object
-
status
string Required Values are
green
,yellow
,red
, orunknown
. -
symptom
string Required -
impacts
array[object] Hide impacts attributes Show impacts attributes object
-
description
string Required -
id
string Required -
impact_areas
array[string] Required Values are
search
,ingest
,backup
, ordeployment_management
. -
severity
number Required
-
-
diagnosis
array[object] Hide diagnosis attributes Show diagnosis attributes object
-
id
string Required -
action
string Required -
affected_resources
object Required Additional properties are allowed.
-
cause
string Required -
help_url
string Required
-
-
details
object Additional properties are allowed.
Hide details attributes Show details attributes object
-
stagnating_backing_indices_count
number Required -
total_backing_indices_in_error
number Required -
stagnating_backing_indices
array[object] Additional properties are allowed.
-
-
-
ilm
object Additional properties are allowed.
Hide ilm attributes Show ilm attributes object
-
status
string Required Values are
green
,yellow
,red
, orunknown
. -
symptom
string Required -
impacts
array[object] Hide impacts attributes Show impacts attributes object
-
description
string Required -
id
string Required -
impact_areas
array[string] Required Values are
search
,ingest
,backup
, ordeployment_management
. -
severity
number Required
-
-
diagnosis
array[object] Hide diagnosis attributes Show diagnosis attributes object
-
id
string Required -
action
string Required -
affected_resources
object Required Additional properties are allowed.
-
cause
string Required -
help_url
string Required
-
-
details
object Additional properties are allowed.
Hide details attributes Show details attributes object
-
ilm_status
string Required Values are
RUNNING
,STOPPING
, orSTOPPED
. -
policies
number Required -
stagnating_indices
number Required
-
-
-
slm
object Additional properties are allowed.
Hide slm attributes Show slm attributes object
-
status
string Required Values are
green
,yellow
,red
, orunknown
. -
symptom
string Required -
impacts
array[object] Hide impacts attributes Show impacts attributes object
-
description
string Required -
id
string Required -
impact_areas
array[string] Required Values are
search
,ingest
,backup
, ordeployment_management
. -
severity
number Required
-
-
diagnosis
array[object] Hide diagnosis attributes Show diagnosis attributes object
-
id
string Required -
action
string Required -
affected_resources
object Required Additional properties are allowed.
-
cause
string Required -
help_url
string Required
-
-
details
object Additional properties are allowed.
Hide details attributes Show details attributes object
-
slm_status
string Required Values are
RUNNING
,STOPPING
, orSTOPPED
. -
policies
number Required -
unhealthy_policies
object Additional properties are allowed.
Hide unhealthy_policies attributes Show unhealthy_policies attributes object
-
count
number Required
-
-
-
-
shards_capacity
object Additional properties are allowed.
Hide shards_capacity attributes Show shards_capacity attributes object
-
status
string Required Values are
green
,yellow
,red
, orunknown
. -
symptom
string Required -
impacts
array[object] Hide impacts attributes Show impacts attributes object
-
description
string Required -
id
string Required -
impact_areas
array[string] Required Values are
search
,ingest
,backup
, ordeployment_management
. -
severity
number Required
-
-
diagnosis
array[object] Hide diagnosis attributes Show diagnosis attributes object
-
id
string Required -
action
string Required -
affected_resources
object Required Additional properties are allowed.
-
cause
string Required -
help_url
string Required
-
-
details
object Additional properties are allowed.
Hide details attributes Show details attributes object
-
data
object Required Additional properties are allowed.
Hide data attributes Show data attributes object
-
max_shards_in_cluster
number Required -
current_used_shards
number
-
-
frozen
object Required Additional properties are allowed.
Hide frozen attributes Show frozen attributes object
-
max_shards_in_cluster
number Required -
current_used_shards
number
-
-
-
-
file_settings
object Additional properties are allowed.
Hide file_settings attributes Show file_settings attributes object
-
status
string Required Values are
green
,yellow
,red
, orunknown
. -
symptom
string Required -
impacts
array[object] Hide impacts attributes Show impacts attributes object
-
description
string Required -
id
string Required -
impact_areas
array[string] Required Values are
search
,ingest
,backup
, ordeployment_management
. -
severity
number Required
-
-
diagnosis
array[object] Hide diagnosis attributes Show diagnosis attributes object
-
id
string Required -
action
string Required -
affected_resources
object Required Additional properties are allowed.
-
cause
string Required -
help_url
string Required
-
-
details
object Additional properties are allowed.
Hide details attributes Show details attributes object
-
failure_streak
number Required -
most_recent_failure
string Required
-
-
-
-
status
string Values are
green
,yellow
,red
, orunknown
.
-
curl \
--request GET http://api.example.com/_health_report \
--header "Authorization: $API_KEY"
{
"cluster_name": "string",
"indicators": {
"": {
"status": "green",
"symptom": "string",
"impacts": [
{
"description": "string",
"id": "string",
"impact_areas": [
"search"
],
"severity": 42.0
}
],
"diagnosis": [
{
"id": "string",
"action": "string",
"affected_resources": {},
"cause": "string",
"help_url": "string"
}
],
"details": {
"failure_streak": 42.0,
"most_recent_failure": "string"
}
}
},
"status": "green"
}