Skip to main content

Retrieve files with the most I/O activity

Contributors
PDFs

GET /storage/volumes/{volume.uuid}/top-metrics/files

Introduced In: 9.10

Retrieves a list of files with the most IO activity.

Parameters

Name Type In Required Description

volume.uuid

string

path

True

Volume UUID

top_metric

string

query

False

I/O activity type

  • Default value: 1

  • enum: ["iops.read", "iops.write", "throughput.read", "throughput.write"]

max_records_per_volume

integer

query

False

Max records per volume.

throughput.write

integer

query

False

Filter by throughput.write

throughput.read

integer

query

False

Filter by throughput.read

throughput.error.lower_bound

integer

query

False

Filter by throughput.error.lower_bound

throughput.error.upper_bound

integer

query

False

Filter by throughput.error.upper_bound

volume.name

string

query

False

Filter by volume.name

path

string

query

False

Filter by path

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

iops.write

integer

query

False

Filter by iops.write

iops.read

integer

query

False

Filter by iops.read

iops.error.lower_bound

integer

query

False

Filter by iops.error.lower_bound

iops.error.upper_bound

integer

query

False

Filter by iops.error.upper_bound

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

  • 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

incomplete_response_reason

incomplete_response_reason

Indicates that the metric report provides incomplete data.

notice

notice

Optional field that indicates why no records are returned by the volume activity tracking REST API.

num_records

integer

Number of records.

records

array[top_metrics_file]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "incomplete_response_reason": {
    "code": "111411207",
    "message": "Partial data has been returned for this metric report. Reason: The activity tracking report for this volume is not available because the system is busy collecting tracking data."
  },
  "notice": {
    "code": "111411207",
    "message": "No read/write traffic on volume."
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "metadata": {
          "href": "/api/resourcelink"
        },
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "iops": {
        "details": [
          {
            "client_ip": "192.168.185.170",
            "read": 5,
            "total": 4,
            "user_id": "S-1-5-21-256008430-3394229847-3930036330-1001",
            "user_name": "James",
            "write": 4
          }
        ],
        "error": {
          "lower_bound": 34,
          "upper_bound": 54
        },
        "read": 5,
        "total": 4,
        "write": 4
      },
      "path": "/dir_abc/dir_123/file_1",
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "throughput": {
        "details": [
          {
            "client_ip": "192.168.185.170",
            "read": 5,
            "total": 4,
            "user_id": "S-1-5-21-256008430-3394229847-3930036330-1001",
            "user_name": "James",
            "write": 4
          }
        ],
        "error": {
          "lower_bound": 34,
          "upper_bound": 54
        },
        "read": 2,
        "total": 20,
        "write": 20
      },
      "volume": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "volume1",
        "uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
      }
    }
  ]
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

124518405

Volume activity tracking is not supported on volumes that contain LUNs.

124518407

Volume activity tracking is not supported on FlexCache volumes.

124518408

Volume activity tracking is not supported on audit staging volumes.

124518409

Volume activity tracking is not supported on object store server volumes.

124518410

Volume activity tracking is not supported on SnapMirror destination volumes.

124518411

Enabling or disabling volume activity tracking is not supported on individual FlexGroup constituents.

124518412

Volume activity tracking is not supported on SnapLock volumes.

124518414

Volume activity tracking is not supported on volumes that contain NVMe namespaces.

124518415

Failed to get the volume activity tracking report on volume volume.name in SVM svm.name.

124518416

Internal error. Volume activity tracking report timed out for volume volume.name in SVM svm.name.

124518417

Volume wildcard queries are not supported for activity tracking reports.

124518418

The activity tracking report for volume volume.name in SVM svm.name returned zero records. Check whether the volume has read/write traffic. Refer to the REST API documentation for more information.

124519411

Volume activity tracking is not enabled on the volume.

Also see the table of common errors in the Response body overview section of this documentation.

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

incomplete_response_reason

Indicates that the metric report provides incomplete data.

Name Type Description

code

string

Warning code indicating why partial data was reported.

message

string

A message describing the reason for partial data.

notice

Optional field that indicates why no records are returned by the volume activity tracking REST API.

Name Type Description

code

string

Warning code indicating why no records are returned.

message

string

Details why no records are returned.

_links

Name Type Description

metadata

href

self

href

top_metric_file_detail

Name Type Description

client_ip

string

IP address of the client. Both IPv4 and IPv6 IP addresses are supported.

read

integer

Average number of read operations or bytes, per second.

total

integer

Average number of read and write operations or read and write bytes, per second.

user_id

string

User ID of the user.

user_name

string

Name of the user.

write

integer

Average number of write operations or bytes, per second.

top_metric_value_error_bounds

Name Type Description

lower_bound

integer

Lower bound of the nominal value of a metric.

upper_bound

integer

Upper bound of the nominal value of a metric.

iops

Name Type Description

details

array[top_metric_file_detail]

error

top_metric_value_error_bounds

read

integer

Average number of read operations per second.

total

integer

Average number of read and write operations, per second.

write

integer

Average number of write operations per second.

_links

Name Type Description

self

href

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.

throughput

Name Type Description

details

array[top_metric_file_detail]

error

top_metric_value_error_bounds

read

integer

Average number of read bytes received per second.

total

integer

Average number of read and write bytes received, per second.

write

integer

Average number of write bytes received per second.

volume

Name Type Description

_links

_links

name

string

The name of the volume. This field cannot be specified in a POST or PATCH method.

uuid

string

Unique identifier for the volume. This corresponds to the instance-uuid that is exposed in the CLI and ONTAPI. It does not change due to a volume move.

  • example: 028baa66-41bd-11e9-81d5-00a0986138f7

  • Introduced in: 9.6

  • x-nullable: true

top_metrics_file

Information about a file's IO activity.

Name Type Description

_links

_links

detailed

boolean

Specifies whether "iops.details" or "throughput.details" is returned with the report. These extra details list the top 10 clients and users contributing to each file in the report.

iops

iops

path

string

Path of the file.

svm

svm

SVM, applies only to SVM-scoped objects.

throughput

throughput

volume

volume

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.