Retrieve files with the most I/O activity
- PDF of this doc site
Collection of separate PDF docs
Creating your file...
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
|
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.
|
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.
|
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
Response
Status: 200, Ok
Name | Type | Description |
---|---|---|
_links |
||
incomplete_response_reason |
Indicates that the metric report provides incomplete data. |
|
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 |
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 |
||
self |
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. |