Skip to main content
REST API reference

Retrieve QoS options

Accesses QoS options to view the current configuration settings available for quality of service management within your storage environment.

HTTP method and endpoint

GET /storage/qos/qos-options

Introduced in

ONTAP 9.14

Usage notes

Retrieves QoS options. This option is available only at diagnostic privilege level and above.

  • qos settings cluster-options show

Parameters

Name Type In Required Description

background_task_reserve

integer

query

False

Filter by background_task_reserve

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

background_task_reserve

integer

Percentage reserve for critical background tasks.

Example response
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "background_task_reserve": 33
}

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

Name Type Description

self

href

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.