Usage report requests
REST API request to get the database usage report from the cluster.
| Redis Software |
|---|
| Method | Path | Description |
|---|---|---|
| GET | /v1/usage_report |
Get the cluster's database usage report |
Get usage report
GET /v1/usage_report
Gets the database usage report from the cluster as Newline Delimited JSON (NDJSON). The response is returned as a gzip file if the request includes the Accept-Encoding: gzip header; otherwise, it returns an NDJSON file directly. The final line in the file is the response's MD5 hash.
Request
Example HTTP request
GET /v1/usage_report
Headers
| Key | Value | Description |
|---|---|---|
| Host | cnm.cluster.fqdn | Domain name |
| Accept | application/json | Accepted media type |
| Accept-Encoding | gzip | (Optional) Request gzip compression for the response |
Response
Returns Newline Delimited JSON (NDJSON), which represents the usage report for every database in the cluster. The response is returned as a gzip file if the request includes the Accept-Encoding: gzip header; otherwise, it returns an NDJSON file directly. The final line in the file is the response's MD5 hash.
| Field | Type/Value | Description |
|---|---|---|
| active_active | boolean | Indicates if Active-Active is enabled |
| api_version | string | API version |
| backup | boolean | Indicates if backup is enabled |
| bdb_uid | string | The database's unique ID |
| cluster_name | string | Cluster name |
| cluster_uuid | string | Cluster's unique ID |
| date | string | Date of the report, including time and time zone |
| dominant_shard_criteria | "mem" "ops" "rof" |
Dominant criteria for shard selection |
| type | "core" "premium" "auto_tiering" |
Database type |
| shard_type | "micro" "normal" "large" "auto_tiering" |
Shard type |
| no_eviction | boolean | Indicates if no eviction policy is applied |
| ops/sec | number | Consolidated ops/sec for the whole database |
| persistence | boolean | Indicates if persistence is enabled |
| provisioned_memory | number | Provisioned memory in bytes |
| replication | boolean | Indicates if replication is enabled |
| software_version | string | The Redis Software version |
| used_memory | number | Used memory in bytes |
| using_redis_search | boolean | Indicates if RediSearch is in use |
| master_shards_count | number | Amount of primary shards |
| license | object | License information for the clusteractivation_date: License activation date and time expiration_date: License expiration date and time ram_shards_in_use: Amount of RAM shards in use ram_shards_limit: Amount of RAM shards allowed flash_shards_in_use: Amount of flash shards in use flash_shards_limit: Amount of flash shards allowed shards_limit: Total shards limit |
Example response
{
"cluster_name": "mycluster.local",
"cluster_uuid": "7e9f93c6-825e-4bbb-a067-7f6306b98609",
"date": "2024-08-08T13:16:00.000000Z",
"software_version": "7.0.0",
"api_version" "1",
"bdb_uid": "1",
"type": "auto_tiering",
"shard_type": "auto_tiering",
"dominant_shard_criteria": "rof",
"provisioned_memory": 1073741824,
"used_memory": 5828776,
"master_shards_count": 3,
"no_eviction": false,
"persistence": false,
"backup": false,
"using_redis_search": false,
"ops_sec": 0,
"replication": false,
"active_active": false,
"license": {
"activation_date": "2018-12-31T00:00:00Z",
"expiration_date": "2019-12-31T00:00:00Z",
"ram_shards_in_use": 0,
"ram_shards_limit": 300,
"flash_shards_in_use": 0,
"flash_shards_limit": 100,
"shards_limit": 400
}
}
{
"cluster_name": "mycluster.local",
"cluster_uuid": "7e9f93c6-825e-4bbb-a067-7f6306b98609",
"date": "2024-08-08T13:17:00.000000Z",
"software_version": "7.0.0",
"api_version" "1",
"bdb_uid": "1",
"type": "auto_tiering",
"shard_type": "auto_tiering",
"dominant_shard_criteria": "rof",
"provisioned_memory": 1073741824,
"used_memory": 5828776,
"master_shards_count": 3,
"no_eviction": false,
"persistence": false,
"backup": false,
"using_redis_search": false,
"ops_sec": 0,
"replication": false,
"active_active": false,
"license": {
"activation_date": "2018-12-31T00:00:00Z",
"expiration_date": "2019-12-31T00:00:00Z",
"ram_shards_in_use": 0,
"ram_shards_limit": 300,
"flash_shards_in_use": 0,
"flash_shards_limit": 100,
"shards_limit": 400
}
}
...
<MD5 hash of the entire response>
Status codes
| Code | Description |
|---|---|
| 200 OK | No error |
| 400 Bad Request | Invalid date format |
| 503 Service Unavailable | Unreachable node |