Home

/elasticsearch/clusters/metrics

Returns the cluster level KPI metrics for Elasticsearch.

Request
GET http://unravel-host:8081/api/v1/elasticsearch/clusters/metrics?start_time={date}&end_time={date}
Path Parameters

None.

Query Parameters

Name

Type

Description

start_time

string

Start date for report.

Format: YYYY-MM-DD

end_time

string

End date for report.

Format: YYYY-MM-DD

Response Fields

Name

Type

Description

nodes_successful

integer

Number of successful nodes for Elasticsearch.

nodes_total

integer

Total number of nodes.

shards_successful

integer

Number of successful shards.

shards_total

integer

Total number of shards.

cluster_name

string

Name of the cluster.

indices_count

integer

Count of the indices.

indices_docs_count

integer

Count of the indices documents.

indices_shards_total

integer

Total number of indices shards.

Examples

Request:

curl -X GET 
"http://localhost:8081/api/v1/elasticsearch/clusters/metrics?start_time=2020-01-01&end_time=2020-04-01" -H  "accept: application/json" -H  "Authorization: JWT token"

Response:

{
  "elasticsearch": {
    "_nodes_successful": 1,
    "_nodes_total": 1,
    "_shards_successful": 392,
    "_shards_total": 774,
    "cluster_name": "elasticsearch",
    "indices_count": 96,
    "indices_docs_count": 1551925314,
    "indices_shards_total": 392
  }
}
In this section: