Skip to main content

Retrieve QoS workloads

Contributors
PDFs

GET /storage/qos/workloads

Introduced In: 9.10

Retrieves a collection of QoS workloads.

Parameters

Name Type In Required Description

name

string

query

False

Filter by name

qtree

string

query

False

Filter by qtree

policy.name

string

query

False

Filter by policy.name

policy.uuid

string

query

False

Filter by policy.uuid

uuid

string

query

False

Filter by uuid

workload_class

string

query

False

Filter by workload_class

volume

string

query

False

Filter by volume

file

string

query

False

Filter by file

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

wid

integer

query

False

Filter by wid

lun

string

query

False

Filter by lun

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

error

error

num_records

integer

Number of records

records

array[qos_workload]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "error": {
    "arguments": {
      "code": "string",
      "message": "string"
    },
    "code": "4",
    "message": "entry doesn't exist"
  },
  "num_records": 1,
  "records": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "file": "string",
    "lun": "string",
    "name": "volume1-wid123",
    "policy": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "performance",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    },
    "qtree": "string",
    "svm": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "svm1",
      "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
    },
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412",
    "volume": "volume1",
    "wid": 123,
    "workload_class": "autovolume"
  }
}

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

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

_links

Name Type Description

self

href

policy

QoS policy group reference.

Name Type Description

_links

_links

name

string

The QoS policy group name. This is mutually exclusive with UUID and other QoS attributes during POST and PATCH.

uuid

string

The QoS policy group UUID. This is mutually exclusive with name and other QoS attributes during POST and PATCH.

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.

qos_workload

Name Type Description

_links

_links

file

string

Name of the file.

lun

string

Name of the LUN. The name of the LUN will be displayed as "(unknown)" if the name cannot be retrieved.

name

string

Name of the QoS workload.

policy

policy

QoS policy group reference.

qtree

string

Name of the Qtree.

svm

svm

SVM, applies only to SVM-scoped objects.

uuid

string

volume

string

Name of the volume. The name of the volume will be displayed as "(unknown)" if the name cannot be retrieved.

wid

integer

Workload ID of the QoS workload.

workload_class

string

Class of the QoS workload.

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.