Skip to main content

Retrieve the quota report records for all FlexVol and FlexGroup volumes

Contributors
PDFs

GET /storage/quota/reports

Introduced In: 9.6

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

  • quota report

Parameters

Name Type In Required Description

specifier

string

query

False

Filter by specifier

group.name

string

query

False

Filter by group.name

group.id

string

query

False

Filter by group.id

users.id

string

query

False

Filter by users.id

users.name

string

query

False

Filter by users.name

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.soft_limit_percent

integer

query

False

Filter by files.used.soft_limit_percent

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

qtree.name

string

query

False

Filter by qtree.name

qtree.id

integer

query

False

Filter by qtree.id

type

string

query

False

Filter by type

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

space.soft_limit

integer

query

False

Filter by space.soft_limit

space.used.hard_limit_percent

integer

query

False

Filter by space.used.hard_limit_percent

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.hard_limit

integer

query

False

Filter by space.hard_limit

volume.uuid

string

query

False

Filter by volume.uuid

volume.name

string

query

False

Filter by volume.name

show_default_records

boolean

query

False

The default is true for GET calls. When set to false, the default records are not reported.

  • Introduced in: 9.7

  • Default value: 1

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

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

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"
    }
  },
  "num_records": 1,
  "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": "string",
      "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

returned_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 associated with the user, group, or tree record. For a user/group quota policy rule at volume level, this parameter is not valid. For a default tree quota policy rule, this parameter is specified as "" or "*". For a tree quota policy rule at qtree level, this parameter specifies a qtree name and a qtree identifier.

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

SVM, applies only to SVM-scoped objects.

Name Type Description

_links

_links

name

string

The name of the SVM. This field cannot be specified in a PATCH method.

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

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. This field cannot be specified in a POST or PATCH method.

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

  • Introduced in: 9.6

  • x-nullable: true

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 associated with the user, group, or tree record. For a user/group quota policy rule at volume level, this parameter is not valid. For a default tree quota policy rule, this parameter is specified as "" or "*". For a tree quota policy rule at qtree level, this parameter specifies a qtree name and a qtree identifier.

space

space

specifier

string

Quota specifier

svm

svm

SVM, applies only to SVM-scoped objects.

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

returned_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.