Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Page Properties
hiddentrue
idrDOC

Product Version2021 Summer
Report Notedraft
AssigneeMartin

Resources & Remarks

  • Version 2.4 - options" ...  "synchronousContentAnalysis": true (OKTO-4309)

Modification History

NameDateProduct VersionAction
Martin12 MAR 20212021 SummerNew page


...

As of Version

product version 2021 Summer | component version 1.1

for non-productive systems: version 2021 Summer RC2

Request MethodGET
Response FormatJSON
Description


Excerpt

Retrieves the current metrics of the tenant


The data are retrieved from the METRICS service. This service evaluates the current status of the system usage and caches the result for 30 seconds. After this time, a new evaluation is executed and the new results replace the previous ones in the cache.

The metrics parameters are:

  • analysisTime: datetime of the call
  • totalObjectCount: the count of existing object instances
  • totalUsedDiskSpace: the used storage space for document files
in bits
  • (attached to current object versions) in bytes

Required user role: YUUVIS_TENANT_ADMIN

Meaning of the response status codes:


HTTP Status CodeMeaning
200 OKSuccessful, the data of all users of the specified tenant have been read.
401 UNAUTHORIZEDThe call was unauthorized.


Request Example

GET /tenant-management/api/admin/metrics HTTP/1.1

Response Example


Panel
{
"analysisTime": "2021-03-11T15:48:01.546+0000",
  "totalObjectCount:" 1080,
  "totalUsedDiskSpace": 6129337139
}


{