Chapter 2. Administration Usage Service
2.1. Administration Usage Service Copy linkLink copied to clipboard!
2.1.1. GetCurrentSecuredUnitsUsage Copy linkLink copied to clipboard!
GET /v1/administration/usage/secured-units/current
GetCurrentSecuredUnitsUsage returns the current secured units usage metrics values.
2.1.1.1. Description Copy linkLink copied to clipboard!
The secured units metrics are collected from all connected clusters every 5 minutes, so the returned result includes data for the connected clusters accurate to about these 5 minutes, and potentially some outdated data for the disconnected clusters.
2.1.1.2. Parameters Copy linkLink copied to clipboard!
2.1.1.3. Return Type Copy linkLink copied to clipboard!
2.1.1.4. Content Type Copy linkLink copied to clipboard!
- application/json
2.1.1.5. Responses Copy linkLink copied to clipboard!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
2.1.1.6. Samples Copy linkLink copied to clipboard!
2.1.2. GetMaxSecuredUnitsUsage Copy linkLink copied to clipboard!
GET /v1/administration/usage/secured-units/max
GetMaxSecuredUnitsUsage returns the maximum, i.e. peak, secured units usage observed during a given time range, together with the time when this maximum was aggregated and stored.
2.1.2.1. Description Copy linkLink copied to clipboard!
The usage metrics are continuously collected from all the connected clusters. The maximum values are kept for some period of time in memory, and then, periodically, are stored to the database. The last data from disconnected clusters are taken into account.
2.1.2.2. Parameters Copy linkLink copied to clipboard!
2.1.2.2.1. Query Parameters Copy linkLink copied to clipboard!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| from | - | null | ||
| to | - | null |
2.1.2.3. Return Type Copy linkLink copied to clipboard!
2.1.2.4. Content Type Copy linkLink copied to clipboard!
- application/json
2.1.2.5. Responses Copy linkLink copied to clipboard!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |