Skip to main content
A newer release of this product is available.

Retrieve the quota report records for all FlexVol and FlexGroup volumes

Contributors
PDFs

GET /storage/quota/reports

Retrieves the quota report records for all FlexVol volumes and FlexGroup volumes.

  • quota report

Learn more

Parameters

Name Type In Required Description

volume.uuid

string

query

False

Filter by volume.uuid

volume.name

string

query

False

Filter by volume.name

users.name

string

query

False

Filter by users.name

users.id

string

query

False

Filter by users.id

index

integer

query

False

Filter by index

files.hard_limit

integer

query

False

Filter by files.hard_limit

files.soft_limit

integer

query

False

Filter by files.soft_limit

files.used.total

integer

query

False

Filter by files.used.total

files.used.hard_limit_percent

integer

query

False

Filter by files.used.hard_limit_percent

files.used.soft_limit_percent

integer

query

False

Filter by files.used.soft_limit_percent

group.name

string

query

False

Filter by group.name

group.id

string

query

False

Filter by group.id

space.soft_limit

integer

query

False

Filter by space.soft_limit

space.used.total

integer

query

False

Filter by space.used.total

space.used.soft_limit_percent

integer

query

False

Filter by space.used.soft_limit_percent

space.used.hard_limit_percent

integer

query

False

Filter by space.used.hard_limit_percent

space.hard_limit

integer

query

False

Filter by space.hard_limit

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

type

string

query

False

Filter by type

specifier

string

query

False

Filter by specifier

qtree.name

string

query

False

Filter by qtree.name

qtree.id

integer

query

False

Filter by qtree.id

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 1

order_by

array[string]

query

False

Order results by specified fields and optional [asc

desc] direction. Default direction is 'asc' for ascending.

show_default_records

boolean

query

False

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[quota_report]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "files": {
      "hard_limit": 0,
      "soft_limit": 0,
      "used": {
        "hard_limit_percent": 0,
        "soft_limit_percent": 0,
        "total": 0
      }
    },
    "group": {
      "id": "string",
      "name": "string"
    },
    "index": 0,
    "qtree": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "id": 1,
      "name": "qt1"
    },
    "space": {
      "hard_limit": 0,
      "soft_limit": 0,
      "used": {
        "hard_limit_percent": 0,
        "soft_limit_percent": 0,
        "total": 0
      }
    },
    "specifier": "string",
    "svm": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "svm1",
      "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
    },
    "type": "tree",
    "users": {
      "id": "string",
      "name": "string"
    },
    "volume": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "volume1",
      "uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
    }
  }
}

Error

Status: Default, Error
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": {
      "code": "string",
      "message": "string"
    },
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

next

href

self

href

_links

Name Type Description

self

href

used

Name Type Description

hard_limit_percent

integer

Total files used as a percentage of file hard limit

soft_limit_percent

integer

Total files used as a percentage of file soft limit

total

integer

Total files used

files

Name Type Description

hard_limit

integer

File hard limit

soft_limit

integer

File soft limit

used

used

group

This parameter specifies the target group associated with the given quota report record. This parameter is available for group quota records and is not available for user or tree quota records. The target group is identified by a UNIX group name and UNIX group identifer.

Name Type Description

id

string

Quota target group ID

name

string

Quota target group name

qtree

This parameter specifies the target qtree to which the user/group/tree quota policy rule applies. For a user/group quota policy rule at qtree level, this parameter takes a qtree name and is valid in GET or POST. For a user/group quota policy rule at volume level, this parameter is not valid in GET or POST. For a tree quota policy rule, this parameter is mandatory and is valid in both POST and GET. For a default tree quota policy rule, this parameter needs to be specified as "". For a tree quota policy rule at qtree level, this parameter takes a qtree name and is valid in GET or POST.

Name Type Description

_links

_links

id

integer

The unique identifier for a qtree.

name

string

The name of the qtree.

used

Name Type Description

hard_limit_percent

integer

Total space used as a percentage of space hard limit

soft_limit_percent

integer

Total space used as a percentage of space soft limit

total

integer

Total space used

space

Name Type Description

hard_limit

integer

Space hard limit in bytes

soft_limit

integer

Space soft limit in bytes

used

used

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

users

Name Type Description

id

string

Quota target user ID

name

string

Quota target user name

volume

Name Type Description

_links

_links

name

string

The name of the volume.

uuid

string

Unique identifier for the volume. This corresponds to the instance-uuid that is exposed in the CLI and ONTAPI. It does not change due to a volume move.

  • example: 028baa66-41bd-11e9-81d5-00a0986138f7

quota_report

Name Type Description

_links

_links

files

files

group

group

This parameter specifies the target group associated with the given quota report record. This parameter is available for group quota records and is not available for user or tree quota records. The target group is identified by a UNIX group name and UNIX group identifer.

index

integer

Index that identifies a unique quota record. Valid in URL.

qtree

qtree

This parameter specifies the target qtree to which the user/group/tree quota policy rule applies. For a user/group quota policy rule at qtree level, this parameter takes a qtree name and is valid in GET or POST. For a user/group quota policy rule at volume level, this parameter is not valid in GET or POST. For a tree quota policy rule, this parameter is mandatory and is valid in both POST and GET. For a default tree quota policy rule, this parameter needs to be specified as "". For a tree quota policy rule at qtree level, this parameter takes a qtree name and is valid in GET or POST.

space

space

specifier

string

Quota specifier

svm

svm

type

string

Quota type associated with the quota record.

users

array[users]

This parameter specifies the target user or users associated with the given quota report record. This parameter is available for user quota records and is not available for group or tree quota records. The target user or users are identified by a user name and user identifier. The user name can be a UNIX user name or a Windows user name, and the identifer can be a UNIX user identifier or a Windows security identifier.

volume

volume

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.