List files with the most I/O activity
- PDF of this doc site
Collection of separate PDF docs
Creating your file...
GET /svm/svms/{svm.uuid}/top-metrics/files
Introduced In: 9.11
Retrieves a list of files with the most I/O activity.
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
svm.uuid |
string |
path |
True |
SVM UUID |
top_metric |
string |
query |
False |
I/O activity type
|
max_records_per_svm |
integer |
query |
False |
Max records per svm. |
iops.read |
integer |
query |
False |
Filter by iops.read |
iops.write |
integer |
query |
False |
Filter by iops.write |
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 |
svm.name |
string |
query |
False |
Filter by svm.name |
path |
string |
query |
False |
Filter by path |
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 |
throughput.read |
integer |
query |
False |
Filter by throughput.read |
throughput.write |
integer |
query |
False |
Filter by throughput.write |
volume.uuid |
string |
query |
False |
Filter by volume.uuid |
volume.name |
string |
query |
False |
Filter by volume.name |
junction-path |
string |
query |
False |
Filter by junction-path |
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 |
||
excluded_volumes |
List of volumes that are not included in the SVM activity tracking REST API. |
|
notice |
Optional field that indicates why no records are returned by the SVM activity tracking REST API. |
|
num_records |
integer |
Number of records. |
records |
array[top_metrics_svm_file] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"excluded_volumes": [
{
"reason": {
"code": "111411207",
"message": "The volume is offline."
},
"volume": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "volume1",
"uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
}
}
],
"notice": {
"code": "111411207",
"message": "The volume is offline."
},
"num_records": 1,
"records": [
{
"_links": {
"metadata": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"iops": {
"error": {
"lower_bound": 34,
"upper_bound": 54
},
"read": 5,
"write": 4
},
"junction-path": "/fv",
"path": "/vol/fv/dir_abc/dir_123/file_1",
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"throughput": {
"error": {
"lower_bound": 34,
"upper_bound": 54
},
"read": 2,
"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 |
---|---|
124519405 |
The activity tracking report for SVM svm.name returned zero records. Check whether the activity tracking enabled volumes belonging to the SVM have read/write traffic. Refer to the REST API documentation for more information on why there might be no records. |
124519406 |
Failed to get the activity tracking report for SVM svm.name. Reason: |
124519407 |
SVM wildcard queries are not supported for activity tracking reports. |
124519408 |
Activity tracking is not supported on SVM svm.name, because it is configured as a destination for SVM DR. |
124519409 |
Activity tracking is not supported on SVM svm.name, because it is configured as a destination of a MetroCluster SVM relationship and the SVM admin state is stopped. |
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 |
reason
Name | Type | Description |
---|---|---|
code |
string |
Warning code indicating why the volume is not included in the SVM activity tracking REST API. |
message |
string |
Details why the volume is not included in the SVM activity tracking REST API. |
_links
Name | Type | Description |
---|---|---|
self |
volume
Name | Type | Description |
---|---|---|
_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.
|
top_metrics_svm_file_excluded_volume
List of volumes and their details as to why they are not included in the SVM activity tracking REST API.
Name | Type | Description |
---|---|---|
reason |
||
volume |
notice
Optional field that indicates why no records are returned by the SVM 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 |
||
self |
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 |
---|---|---|
error |
||
read |
integer |
Average number of read operations per second. |
write |
integer |
Average number of write operations per second. |
svm
SVM, applies only to SVM-scoped objects.
Name | Type | Description |
---|---|---|
_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 |
---|---|---|
error |
||
read |
integer |
Average number of read bytes received per second. |
write |
integer |
Average number of write bytes received per second. |
top_metrics_svm_file
Information about a file's IO activity.
Name | Type | Description |
---|---|---|
_links |
||
iops |
||
junction-path |
string |
Junction path of the file. |
path |
string |
Path of the file. |
svm |
SVM, applies only to SVM-scoped objects. |
|
throughput |
||
volume |