Get Usage

Get Usage

Operation ID: getUsage
Get the platform usage of global (without query parameter), tenant (only with tenant_id) or user (with tenant_id and user_id).

Request
URI
GET
https://{api_host}/api/v1/usage
COPY
Query Parameters
string
tenant_id
Optional

The ID of the tenant to get its usage.

string
user_id
Optional

The ID of the user to get its usage.

Authentication
This operation uses the following authentication methods.
Responses
200

The usage of the tenant or user is returned

Returns OsisUsage of type(s) application/json 
{
    "available_bytes": 48193854929,
    "used_bytes": 32754375834,
    "total_bytes": 80948230763,
    "object_count": 298635,
    "bucket_count": 532
}
integer As int64 As int64
bucket_count
Required

Bucket count of platform tenant or user.

integer As int64 As int64
object_count
Required

Object count of platform tenant or user.

integer As int64 As int64
total_bytes
Required

Total storage bytes of platform tenant or user.

integer As int64 As int64
available_bytes
Required

Available storage bytes of platform tenant or user.

integer As int64 As int64
used_bytes
Required

Used storage bytes of platform tenant or user.


501

The optional API is not implemented

Operation doesn't return any data structure

On This Page
Usage Operations
GET
Get Usage