You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/operate/rs/references/rest-api/requests/usage_report/_index.md
+28-8Lines changed: 28 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ weight: $weight
22
22
GET /v1/usage_report
23
23
```
24
24
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.
26
26
27
27
### Request {#get-request}
28
28
@@ -38,10 +38,11 @@ GET /v1/usage_report
38
38
|-----|-------|-------------|
39
39
| Host | cnm.cluster.fqdn | Domain name |
40
40
| Accept | application/json | Accepted media type |
41
+
| Accept-Encoding | gzip | (Optional) Request gzip compression for the response |
41
42
42
43
### Response {#get-response}
43
44
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.
45
46
46
47
| Field | Type/Value | Description |
47
48
|-------|------------|-------------|
@@ -52,18 +53,19 @@ Returns a gzip file that contains Newline Delimited JSON (NDJSON), which represe
52
53
| cluster_name | string | Cluster name |
53
54
| cluster_uuid | string | Cluster's unique ID |
54
55
| date | string | Date of the report, including time and time zone |
0 commit comments