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

Retrieve a QoS workload

Contributors
PDFs

GET /storage/qos/workloads/{uuid}

Introduced In: 9.10

Retrieves a specific QoS workload.

  • qos workload show

Parameters

Name Type In Required Description

uuid

string

path

True

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
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

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.
Example response 
{
  "_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

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

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

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

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.