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

Retrieve historical performance metrics for a volume

Contributors
PDFs

GET /storage/volumes/{volume.uuid}/metrics

Introduced In: 9.7

Retrieves historical performance metrics for a volume.

Parameters

Name Type In Required Description

iops.total

integer

query

False

Filter by iops.total

iops.write

integer

query

False

Filter by iops.write

iops.other

integer

query

False

Filter by iops.other

iops.read

integer

query

False

Filter by iops.read

throughput.total

integer

query

False

Filter by throughput.total

throughput.write

integer

query

False

Filter by throughput.write

throughput.other

integer

query

False

Filter by throughput.other

throughput.read

integer

query

False

Filter by throughput.read

duration

string

query

False

Filter by duration

cloud.iops.total

integer

query

False

Filter by cloud.iops.total

cloud.iops.write

integer

query

False

Filter by cloud.iops.write

cloud.iops.other

integer

query

False

Filter by cloud.iops.other

cloud.iops.read

integer

query

False

Filter by cloud.iops.read

cloud.status

string

query

False

Filter by cloud.status

cloud.duration

string

query

False

Filter by cloud.duration

cloud.latency.total

integer

query

False

Filter by cloud.latency.total

cloud.latency.write

integer

query

False

Filter by cloud.latency.write

cloud.latency.other

integer

query

False

Filter by cloud.latency.other

cloud.latency.read

integer

query

False

Filter by cloud.latency.read

cloud.timestamp

string

query

False

Filter by cloud.timestamp

status

string

query

False

Filter by status

flexcache.timestamp

string

query

False

Filter by flexcache.timestamp

  • Introduced in: 9.8

flexcache.duration

string

query

False

Filter by flexcache.duration

  • Introduced in: 9.8

flexcache.cache_miss_percent

integer

query

False

Filter by flexcache.cache_miss_percent

  • Introduced in: 9.8

flexcache.status

string

query

False

Filter by flexcache.status

  • Introduced in: 9.8

flexcache.bandwidth_savings

integer

query

False

Filter by flexcache.bandwidth_savings

  • Introduced in: 9.9

latency.total

integer

query

False

Filter by latency.total

latency.write

integer

query

False

Filter by latency.write

latency.other

integer

query

False

Filter by latency.other

latency.read

integer

query

False

Filter by latency.read

timestamp

string

query

False

Filter by timestamp

volume.uuid

string

path

True

Unique identifier of the volume.

interval

string

query

False

The time range for the data. Examples can be 1h, 1d, 1m, 1w, 1y. The period for each time range is as follows:

  • 1h: Metrics over the most recent hour sampled over 15 seconds.

  • 1d: Metrics over the most recent day sampled over 5 minutes.

  • 1w: Metrics over the most recent week sampled over 30 minutes.

  • 1m: Metrics over the most recent month sampled over 2 hours.

  • 1y: Metrics over the most recent year sampled over a day.

  • Default value: 1

  • enum: ["1h", "1d", "1w", "1m", "1y"]

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

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

order_by

array[string]

query

False

Order results by specified fields and optional [asc

desc] direction. Default direction is 'asc' for ascending.

return_records

boolean

query

False

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[records]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "duration": "PT15S",
      "iops": {
        "read": 200,
        "total": 1000,
        "write": 100
      },
      "latency": {
        "read": 200,
        "total": 1000,
        "write": 100
      },
      "status": "ok",
      "throughput": {
        "read": 200,
        "total": 1000,
        "write": 100
      },
      "timestamp": "2017-01-25T11:20:13Z"
    }
  ]
}

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

iops

The rate of I/O operations observed at the storage object.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

latency

The round trip latency in microseconds observed at the storage object.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

throughput

The rate of throughput bytes per second observed at the storage object.

Name Type Description

other

integer

Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on.

read

integer

Performance metric for read I/O operations.

total

integer

Performance metric aggregated over all types of I/O operations.

write

integer

Peformance metric for write I/O operations.

records

Performance numbers, such as IOPS latency and throughput.

Name Type Description

_links

_links

duration

string

The duration over which this sample is calculated. The time durations are represented in the ISO-8601 standard format. Samples can be calculated over the following durations:

iops

iops

The rate of I/O operations observed at the storage object.

latency

latency

The round trip latency in microseconds observed at the storage object.

status

string

Errors associated with the sample. For example, if the aggregation of data over multiple nodes fails, then any partial errors might return "ok" on success or "error" on an internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "Inconsistent_ delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "Inconsistent_old_data" is returned when one or more nodes do not have the latest data.

throughput

throughput

The rate of throughput bytes per second observed at the storage object.

timestamp

string

The timestamp of the performance data.

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.