content/operate/rs/references/rest-api/requests/endpoints-stats/_index.md
{{<banner-article>}} The v1 statistics REST API endpoints are deprecated as of Redis Software version 7.22. Use the [metrics stream engine for monitoring v2]({{< relref "/operate/rs/monitoring/metrics_stream_engine" >}}) instead for real-time monitoring and metrics collection. {{</banner-article>}}
| Method | Path | Description |
|---|---|---|
| GET | /v1/endpoints/stats | Get stats for all endpoints |
GET /v1/endpoints/stats
Get statistics for all endpoint-proxy links.
{{<note>}} This method will return both endpoints and listeners stats for backwards compatability. {{</note>}}
| Permission name |
|---|
| [view_endpoint_stats]({{< relref "/operate/rs/references/rest-api/permissions#view_endpoint_stats" >}}) |
GET /v1/endpoints/stats?interval=1hour&stime=2014-08-28T10:00:00Z
| Key | Value | Description |
|---|---|---|
| Host | cnm.cluster.fqdn | Domain name |
| Accept | application/json | Accepted media type |
| Field | Type | Description |
|---|---|---|
| interval | string | Time interval for which we want stats: 1sec/10sec/5min/15min/1hour/12hour/1week (optional) |
| stime | ISO_8601 | Start time from which we want the stats. Should comply with the ISO_8601 format (optional) |
| etime | ISO_8601 | End time after which we don't want the stats. Should comply with the ISO_8601 format (optional) |
The uid format in the response is: "BDB_UID:ENDPOINT_UID:PROXY_UID"
For example: {"uid": "1:2:3"} means BDB_UID=1, ENDPOINT_UID=2, and PROXY_UID=3
[
{
"uid" : "365:1:1",
"intervals" : [
{
"interval" : "10sec",
"total_req" : 0,
"egress_bytes" : 0,
"cmd_get" : 0,
"monitor_sessions_count" : 0,
"auth_errors" : 0,
"acc_latency" : 0,
"stime" : "2017-01-12T14:59:50Z",
"write_res" : 0,
"total_connections_received" : 0,
"cmd_set" : 0,
"read_req" : 0,
"max_connections_exceeded" : 0,
"acc_write_latency" : 0,
"write_req" : 0,
"other_res" : 0,
"cmd_flush" : 0,
"acc_read_latency" : 0,
"other_req" : 0,
"conns" : 0,
"write_started_res" : 0,
"cmd_touch" : 0,
"read_res" : 0,
"auth_cmds" : 0,
"etime" : "2017-01-12T15:00:00Z",
"total_started_res" : 0,
"ingress_bytes" : 0,
"last_res_time" : 0,
"read_started_res" : 0,
"acc_other_latency" : 0,
"total_res" : 0,
"last_req_time" : 0,
"other_started_res" : 0
}
]
},
{
"intervals" : [
{
"acc_read_latency" : 0,
"other_req" : 0,
"etime" : "2017-01-12T15:00:00Z",
"auth_cmds" : 0,
"total_started_res" : 0,
"write_started_res" : 0,
"cmd_touch" : 0,
"conns" : 0,
"read_res" : 0,
"total_res" : 0,
"other_started_res" : 0,
"last_req_time" : 0,
"read_started_res" : 0,
"last_res_time" : 0,
"ingress_bytes" : 0,
"acc_other_latency" : 0,
"egress_bytes" : 0,
"interval" : "10sec",
"total_req" : 0,
"acc_latency" : 0,
"auth_errors" : 0,
"cmd_get" : 0,
"monitor_sessions_count" : 0,
"read_req" : 0,
"max_connections_exceeded" : 0,
"total_connections_received" : 0,
"cmd_set" : 0,
"acc_write_latency" : 0,
"write_req" : 0,
"stime" : "2017-01-12T14:59:50Z",
"write_res" : 0,
"cmd_flush" : 0,
"other_res" : 0
}
],
"uid" : "333:1:2"
}
]
| Code | Description |
|---|---|
| 200 OK | No error |