Home

/elasticsearch/{cluster}/kpi_cluster

Returns the cluster level value of a specific metric.

Request
GET http://unravel-host/api/v1/elasticsearch/{cluster}/kpi_cluster?start_time={date}&end_time={date}&prefix={metrics}"
Path Parameters

Name

Type

Description

{cluster}

string

Name of the cluster.

Query Parameters

Name

Type

Description

{cluster}

string

Cluster name.

start_time

string

Start date for report.

Format: YYYY-MM-DD

end_time

string

End date for report.

Format: YYYY-MM-DD

prefix

string

Any of the following metrics:

  • search_rate

  • search_latency

  • indexing_rate

  • Indexing_latency

Response Fields

Name

Type

Description

Cluster name

string

Name of the cluster

ts

-

Timestamp

avg_vd

string

Value of the metrics in a specific timestamp.

Examples

Request:

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

Response:

{
  "elasticsearch": [
    {
      "ts": 1585746000000,
      "avg_vd": 0
    }
  ]
}
In this section: