/kafka/{cluster_name}/kpi_clusters?start_time={timestamp}&end_time={timestamp}&interval={minutes}&prefix={metrics}
Gets KPIs for a given Kafka cluster.
Request
GET http://unravel-host:3000/api/v1/kafka/{cluster_name}/kpi_clusters?start_time={timestamp}&end_time={timestamp}&interval={interval}&prefix={metrics}Path parameters
Name | Description |
|---|---|
| Cluster name. |
Query parameters
Required parameters are highlighted.
Name | Type | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| string | Start time. Format: | |||||||||||||||
| string | End time. Format: | |||||||||||||||
| string | Interval size, in minutes. Valid values are | |||||||||||||||
| string | Metric to graph. Valid values are:
|
Response body
The response is one array per cluster, with the following KPIs:
Name | Type | Description |
|---|---|---|
| string | Timestamp. |
| string |
Examples
Request:
curl -X GET "http://myserver.com:3000/api/v1/kafka/QAHDP26B/kpi_clusters?end_time=2019-06-03T16:56:09%2B05:30&interval=1m&prefix=BytesInPerSec&start_time=2019-06-03T15:56:09%2B05:30" -H "accept: application/json" -H "Authorization: JWT token"Response:
{ "QAHDP26B": [ { "Ts":1559557560000, "avg_vd":"0.000000000000" } ] }