Get View user quotas.

get

https://helios.cohesity.com/v2/file-services/views/user-quotas

Get user quotas for the View.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

viewId

int64

Specifies the View id. One of viewId, unixUid, sid must be specified.

includeUsage

boolean

If set to true, the logical usage info is included only for users with quota overrides. By default, it is set to false.

includeUserWithQuotaOverridesOnly

boolean

If set to true, the result will only contain user with user quota override enabled. By default, this field is set to false, and it's only in effect when 'SummaryOnly' is set to false.

excludeUsersWithinAlertThreshold

boolean

This field can be set only when includeUsage is set to true. By default, all the users with logical usage > 0 will be returned in the result. If this field is set to true, only the list of users who has exceeded the alert threshold will be returned.

summaryOnly

boolean

Specifies a flag to just return a summary. If set to true, it returns the summary of users for a view. By default, it is set to false.

outputFormat

string

enum

Defaults to json

OutputFormat is the Output format for the output. If it is not specified, default is json.

Allowed:

topQuotas

int64

TopQuotas is the quotas sorted by quota usage in descending order. This parameter defines number of results to be returned. No pagination cookie is returned if this parameter is set.

maxCount

int64

Specifies a limit on the number of quotas returned. If maxCount is not set, response will have a maximum of 100 results. This parameter will be ignored if 'topQuotas' is set.

string

Specifies the cookie. If there are more results than maxCount, response will include a cookie with has to be set as part of the next GET request.

unixUid

uint32

Specifies the user identifier of an Unix user. If a valid unix-id to SID mappings are available (i.e., when mixed mode is enabled) the server will perform the necessary id mapping and return the correct usage irrespective of whether the unix id / SID is provided. One of viewId, unixUid, sid must be specified.

sid

string

Specifies the user identifier of a SMB user. If a valid unix-id to SID mappings are available (i.e., when mixed mode is enabled) the server will perform the necessary id mapping and return the correct usage irrespective of whether the unix id / SID is provided. One of viewId, unixUid, sid must be specified.

userUnixIdsForView

array of uint32s

While making a query for a view, this specifies a list of specific users with their unix uid for the result.

userUnixIdsForView

userSidsForView

array of strings

While making a query for a view, this specifies a list of specific users with their Sid for the result.

userSidsForView

viewNamesForUser

array of strings

While making a query for a user, this specifies a list of specific views for the result.

viewNamesForUser

pageCount

int64

Specifies the max entries that should be returned in the result.

maxViewId

int64

Related to fetching a particular user's quota and usage in all his views. It only pertains to the scenario where either UnixUid or Sid is specified, and ViewName is nil. Specify the maxViewId for All the views returned would have view_id's less than or equal to the given MaxViewId if it is >= 0.

Headers

accessClusterId

int64

This field uniquely represents a Cohesity Cluster and is used for making on-prem calls from Helios.

Responses

200Success

defaultError