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

Retrieve volume efficiency policies

PDFs

GET /storage/volume-efficiency-policies

Introduced In: 9.8

Retrieves a collection of volume efficiency policies.

  • volume efficiency policy show

Learn more

Parameters

Name Type In Required Description

enabled

boolean

query

False

Filter by enabled

qos_policy

string

query

False

Filter by qos_policy

uuid

string

query

False

Filter by uuid

comment

string

query

False

Filter by comment

name

string

query

False

Filter by name

type

string

query

False

Filter by type

duration

integer

query

False

Filter by duration

schedule.name

string

query

False

Filter by schedule.name

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

start_threshold_percent

integer

query

False

Filter by start_threshold_percent

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: 15

  • 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[volume_efficiency_policy]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "comment": "string",
      "duration": 5,
      "enabled": 1,
      "name": "default",
      "qos_policy": "string",
      "schedule": {
        "name": "daily"
      },
      "start_threshold_percent": 30,
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "type": "string",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    }
  ]
}

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

next

href

self

href

_links

Name Type Description

self

href

schedule

Name Type Description

name

string

Schedule at which volume efficiency policies are captured on the SVM. Some common schedules already defined in the system are hourly, daily, weekly, at 5 minute intervals, and at 8 hour intervals. Volume efficiency policies with custom schedules can be referenced.

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

volume_efficiency_policy

Name Type Description

_links

_links

comment

string

A comment associated with the volume efficiency policy.

duration

integer

This field is used with the policy type "scheduled" to indicate the allowed duration for a session, in hours. Possible value is a number between 0 and 999 inclusive. Default is unlimited indicated by value 0.

enabled

boolean

Is the volume efficiency policy enabled?

name

string

Name of the volume efficiency policy.

qos_policy

string

QoS policy for the sis operation. Possible values are background and best_effort. In background, sis operation will run in background with minimal or no impact on data serving client operations. In best_effort, sis operations may have some impact on data serving client operations.

schedule

schedule

start_threshold_percent

integer

This field is used with the policy type "threshold" to indicate the threshold percentage for triggering the volume efficiency policy. It is mutuallly exclusive of the schedule.

svm

svm

type

string

Type of volume efficiency policy.

uuid

string

Unique identifier of volume efficiency policy.

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.