Gets the statistics of consumers.

get

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

Privileges: STORAGE_VIEW, PROTECTION_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:

consumerIds

array of strings

ConsumerIds specifies fully qualified consumer IDs in the format:

If only

For consumerType = kReplicationRuns, this must be the consumer ID
from the original (source) cluster.

If this field is set, ConsumerIdList is ignored.

consumerIds

consumerIdList

array of int64s

ConsumerIdList specifies a list of consumer IDs.
Deprecated: Use ConsumerIds instead.

consumerIdList

consumerEntityIdList

array of strings

Specifies a list of consumer entity ids. If this field is specified, each
entity id must correspond to the id in ConsumerIds / ConsumerIdList in
the same index, and the length of 'ConsumerEntityIdList' and
ConsumerIds / ConsumerIdList must be the same.

consumerEntityIdList

fetchViewBoxName

boolean

Specifies whether to fetch view box (storage domain) name for each
consumer.

fetchTenantName

boolean

Specifies whether to fetch tenant (organization) name for each consumer.

fetchProtectionPolicy

boolean

Specifies whether to fetch protection policy for each consumer. This field
is applicable only if 'consumerType' is 'kProtectionRuns' or
'kReplicationRuns'.

fetchProtectionEnvironment

boolean

Specifies whether to fetch protection environment for each consumer. This
field is applicable only if 'consumerType' is 'kProtectionRuns' or
'kReplicationRuns'.

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