Skip to main content

Retrieve QoS policies

Contributors
PDFs

GET /storage/qos/policies

Introduced In: 9.6

Retrieves a collection of QoS policies.

Parameters

Name Type In Required Description

uuid

string

query

False

Filter by uuid

pgid

integer

query

False

Filter by pgid

  • Introduced in: 9.10

policy_class

string

query

False

Filter by policy_class

  • Introduced in: 9.10

object_count

integer

query

False

Filter by object_count

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

adaptive.peak_iops

integer

query

False

Filter by adaptive.peak_iops

adaptive.expected_iops_allocation

string

query

False

Filter by adaptive.expected_iops_allocation

  • Introduced in: 9.10

adaptive.peak_iops_allocation

string

query

False

Filter by adaptive.peak_iops_allocation

  • Introduced in: 9.10

adaptive.absolute_min_iops

integer

query

False

Filter by adaptive.absolute_min_iops

adaptive.expected_iops

integer

query

False

Filter by adaptive.expected_iops

adaptive.block_size

string

query

False

Filter by adaptive.block_size

  • Introduced in: 9.10

fixed.capacity_shared

boolean

query

False

Filter by fixed.capacity_shared

fixed.max_throughput_mbps

integer

query

False

Filter by fixed.max_throughput_mbps

  • Max value: 4194303

  • Min value: 0

fixed.max_throughput_iops

integer

query

False

Filter by fixed.max_throughput_iops

  • Max value: 2147483647

  • Min value: 0

fixed.min_throughput_iops

integer

query

False

Filter by fixed.min_throughput_iops

  • Max value: 2147483647

  • Min value: 0

fixed.min_throughput_mbps

integer

query

False

Filter by fixed.min_throughput_mbps

  • Introduced in: 9.8

  • Max value: 4194303

  • Min value: 0

name

string

query

False

Filter by name

scope

string

query

False

Filter by scope

  • Introduced in: 9.11

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.

  • Max value: 120

  • Min value: 0

  • Default value: 1

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_policy]
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"
        }
      },
      "adaptive": {
        "block_size": "string",
        "expected_iops_allocation": "string",
        "peak_iops_allocation": "string"
      },
      "name": "extreme",
      "object_count": 0,
      "pgid": 0,
      "policy_class": "string",
      "scope": "string",
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    }
  ]
}

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

adaptive

Adaptive QoS policy-groups define measurable service level objectives (SLOs) that adjust based on the storage object used space and the storage object allocated space.

Name Type Description

absolute_min_iops

integer

Specifies the absolute minimum IOPS that is used as an override when the expected_iops is less than this value. These floors are not guaranteed on non-AFF platforms or when FabricPool tiering policies are set.

block_size

string

Specifies the block size

expected_iops

integer

Expected IOPS. Specifies the minimum expected IOPS per TB allocated based on the storage object allocated size. These floors are not guaranteed on non-AFF platforms or when FabricPool tiering policies are set.

expected_iops_allocation

string

Specifies the size to be used to calculate expected IOPS per TB. The size options are either the storage object allocated space or the storage object used space.

peak_iops

integer

Peak IOPS. Specifies the maximum possible IOPS per TB allocated based on the storage object allocated size or the storage object used size.

peak_iops_allocation

string

Specifies the size to be used to calculate peak IOPS per TB. The size options are either the storage object allocated space or the storage object used space.

fixed

QoS policy-groups define a fixed service level objective (SLO) for a storage object.

Name Type Description

capacity_shared

boolean

Specifies whether the capacities are shared across all objects that use this QoS policy-group. Default is false.

max_throughput_iops

integer

Maximum throughput defined by this policy. It is specified in terms of IOPS. 0 means no maximum throughput is enforced.

max_throughput_mbps

integer

Maximum throughput defined by this policy. It is specified in terms of Mbps. 0 means no maximum throughput is enforced.

min_throughput_iops

integer

Minimum throughput defined by this policy. It is specified in terms of IOPS. 0 means no minimum throughput is enforced. These floors are not guaranteed on non-AFF platforms or when FabricPool tiering policies are set.

min_throughput_mbps

integer

Minimum throughput defined by this policy. It is specified in terms of Mbps. 0 means no minimum throughput is enforced.

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_policy

Name Type Description

_links

_links

adaptive

adaptive

Adaptive QoS policy-groups define measurable service level objectives (SLOs) that adjust based on the storage object used space and the storage object allocated space.

fixed

fixed

QoS policy-groups define a fixed service level objective (SLO) for a storage object.

name

string

Name of the QoS policy.

object_count

integer

Number of objects attached to this policy.

pgid

integer

Policy group ID of the QoS policy.

policy_class

string

Class of the QoS policy.

scope

string

Scope of the entity. Set to "cluster" for cluster owned objects and to "svm" for SVM owned objects.

svm

svm

SVM, applies only to SVM-scoped objects.

uuid

string

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.