Skip to content

Commit 26311e5

Browse files
committed
DOC-6295 RS 8.0.10-81 release notes
1 parent fc6aa96 commit 26311e5

File tree

2 files changed

+399
-8
lines changed

2 files changed

+399
-8
lines changed

content/operate/rs/references/rest-api/requests/usage_report/_index.md

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ weight: $weight
2222
GET /v1/usage_report
2323
```
2424

25-
Gets the database usage report from the cluster as a gzip file that contains Newline Delimited JSON (NDJSON). The final line in the file is the response's MD5 hash.
25+
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.
2626

2727
### Request {#get-request}
2828

@@ -38,10 +38,11 @@ GET /v1/usage_report
3838
|-----|-------|-------------|
3939
| Host | cnm.cluster.fqdn | Domain name |
4040
| Accept | application/json | Accepted media type |
41+
| Accept-Encoding | gzip | (Optional) Request gzip compression for the response |
4142

4243
### Response {#get-response}
4344

44-
Returns a gzip file that contains Newline Delimited JSON (NDJSON), which represents the usage report for every database in the cluster. The final line in the file is the response's MD5 hash.
45+
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.
4546

4647
| Field | Type/Value | Description |
4748
|-------|------------|-------------|
@@ -52,18 +53,19 @@ Returns a gzip file that contains Newline Delimited JSON (NDJSON), which represe
5253
| cluster_name | string | Cluster name |
5354
| cluster_uuid | string | Cluster's unique ID |
5455
| date | string | Date of the report, including time and time zone |
55-
| dominant_shard_criteria | "mem"<br />"ops"<br />"rof" | Dominant criteria for shard selection |
56+
| <span class="break-all">dominant_shard_criteria</span> | "mem"<br />"ops"<br />"rof" | Dominant criteria for shard selection |
5657
| type | "core"<br />"premium"<br />"auto_tiering" | Database type |
5758
| shard_type | "micro"<br />"normal"<br />"large"<br />"auto_tiering" | Shard type |
5859
| no_eviction | boolean | Indicates if no eviction policy is applied |
5960
| ops/sec | number | Consolidated ops/sec for the whole database |
6061
| persistence | boolean | Indicates if persistence is enabled |
61-
| provisioned_memory | number | Provisioned memory in bytes |
62+
| <span class="break-all">provisioned_memory</span> | number | Provisioned memory in bytes |
6263
| replication | boolean | Indicates if replication is enabled |
6364
| software_version | string | The Redis Software version |
6465
| used_memory | number | Used memory in bytes |
65-
| using_redis_search | boolean | Indicates if RediSearch is in use |
66-
| master_shards_count | number | Amount of primary shards |
66+
| <span class="break-all">using_redis_search</span> | boolean | Indicates if RediSearch is in use |
67+
| <span class="break-all">master_shards_count</span> | number | Amount of primary shards |
68+
| license | object | License information for the cluster<br />{{<code>}} "license": {<br /> "activation_date": string,<br /> "expiration_date": string,<br /> "ram_shards_in_use": integer,<br /> "ram_shards_limit": integer,<br /> "flash_shards_in_use": integer,<br /> "flash_shards_limit": integer,<br /> "shards_limit": integer<br />}{{</code>}}<br />**activation_date**: License activation date and time<br />**expiration_date**: License expiration date and time<br />**ram_shards_in_use**: Amount of RAM shards in use<br />**ram_shards_limit**: Amount of RAM shards allowed<br />**flash_shards_in_use**: Amount of flash shards in use<br />**flash_shards_limit**: Amount of flash shards allowed<br />**shards_limit**: Total shards limit |
6769

6870
#### Example response
6971

@@ -87,7 +89,16 @@ Returns a gzip file that contains Newline Delimited JSON (NDJSON), which represe
8789
"using_redis_search": false,
8890
"ops_sec": 0,
8991
"replication": false,
90-
"active_active": false
92+
"active_active": false,
93+
"license": {
94+
"activation_date": "2018-12-31T00:00:00Z",
95+
"expiration_date": "2019-12-31T00:00:00Z",
96+
"ram_shards_in_use": 0,
97+
"ram_shards_limit": 300,
98+
"flash_shards_in_use": 0,
99+
"flash_shards_limit": 100,
100+
"shards_limit": 400
101+
}
91102
}
92103
{
93104
"cluster_name": "mycluster.local",
@@ -108,7 +119,16 @@ Returns a gzip file that contains Newline Delimited JSON (NDJSON), which represe
108119
"using_redis_search": false,
109120
"ops_sec": 0,
110121
"replication": false,
111-
"active_active": false
122+
"active_active": false,
123+
"license": {
124+
"activation_date": "2018-12-31T00:00:00Z",
125+
"expiration_date": "2019-12-31T00:00:00Z",
126+
"ram_shards_in_use": 0,
127+
"ram_shards_limit": 300,
128+
"flash_shards_in_use": 0,
129+
"flash_shards_limit": 100,
130+
"shards_limit": 400
131+
}
112132
}
113133
...
114134
<MD5 hash of the entire response>

0 commit comments

Comments
 (0)