Gets the statistics of organizations (tenant).

get

https://cluster.ip.address/irisservices/api/v1/public/stats/tenants

Privileges: STORAGE_VIEW

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

consumerType

string

enum

Specifies the consumer type.
Type of the consumer can be one of the following three,

'kViews', indicates the stats info of Views used per organization (tenant)
per view box (storage domain).
'kProtectionRuns', indicates the stats info of Protection Runs used per
organization (tenant) per view box (storage domain).
'kReplicationRuns', indicates the stats info of Replication In used per
organization (tenant) per view box (storage domain).
'kViewProtectionRuns', indicates the stats info of View Protection Runs used
per organization (tenant) per view box (storage domain).

Allowed:

skipGroupByTenant

boolean

Specifies if we should skip grouping by tenant. If false, and tenant has
multiple storage domains, then the stats for the storage domains will be
aggregated. If true, then the response will return each storage domain
cross tenant independently.

outputFormat

string

Specifies what format to return the data in. Defaults to proto, but can
select other options like csv.

viewBoxesIdList

array of int64s

Specifies a list of view boxes (storage domain) id.

viewBoxesIdList

organizationsIdList

array of strings

Specifies a list of organizations (tenant) id.

organizationsIdList

tenantIds

array of strings

Specifies a list of organizations (tenant) id. This field is added to
allow tenantIds json tag. This list will be concatenated with
TenantsIdList to form full list of tenantsIdList.

tenantIds

includeServiceProvider

boolean

Specifies whether to fetch the consumption of external service providers.
These information will be listed as a unique organization (tenant) in
response. By default it is false.

msecsBeforeCurrentTimeToCompare

int64

Specifies the time in msecs before current time to compare with.

maxCount

int64

Specifies a limit on the number of stats groups returned.

Specifies the opaque string returned in the previous response.
If this is set, next set of active opens just after the previous
response are returned. If this is not set, first set of active opens
are returned.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

defaultError