Skip to main content

Retrieve NFS protocol historical performance metrics

Contributors
PDFs

GET /protocols/nfs/services/{svm.uuid}/metrics

Introduced In: 9.7

Retrieves historical performance metrics for the NFS protocol of an SVM.

Parameters

Name Type In Required Description

v4.latency.write

integer

query

False

Filter by v4.latency.write

  • Introduced in: 9.8

v4.latency.read

integer

query

False

Filter by v4.latency.read

  • Introduced in: 9.8

v4.latency.other

integer

query

False

Filter by v4.latency.other

  • Introduced in: 9.8

v4.latency.total

integer

query

False

Filter by v4.latency.total

  • Introduced in: 9.8

v4.iops.write

integer

query

False

Filter by v4.iops.write

  • Introduced in: 9.8

v4.iops.read

integer

query

False

Filter by v4.iops.read

  • Introduced in: 9.8

v4.iops.other

integer

query

False

Filter by v4.iops.other

  • Introduced in: 9.8

v4.iops.total

integer

query

False

Filter by v4.iops.total

  • Introduced in: 9.8

v4.status

string

query

False

Filter by v4.status

  • Introduced in: 9.8

v4.duration

string

query

False

Filter by v4.duration

  • Introduced in: 9.8

v4.throughput.total

integer

query

False

Filter by v4.throughput.total

  • Introduced in: 9.8

v4.throughput.write

integer

query

False

Filter by v4.throughput.write

  • Introduced in: 9.8

v4.throughput.read

integer

query

False

Filter by v4.throughput.read

  • Introduced in: 9.8

v41.iops.write

integer

query

False

Filter by v41.iops.write

  • Introduced in: 9.8

v41.iops.read

integer

query

False

Filter by v41.iops.read

  • Introduced in: 9.8

v41.iops.other

integer

query

False

Filter by v41.iops.other

  • Introduced in: 9.8

v41.iops.total

integer

query

False

Filter by v41.iops.total

  • Introduced in: 9.8

v41.latency.write

integer

query

False

Filter by v41.latency.write

  • Introduced in: 9.8

v41.latency.read

integer

query

False

Filter by v41.latency.read

  • Introduced in: 9.8

v41.latency.other

integer

query

False

Filter by v41.latency.other

  • Introduced in: 9.8

v41.latency.total

integer

query

False

Filter by v41.latency.total

  • Introduced in: 9.8

v41.throughput.total

integer

query

False

Filter by v41.throughput.total

  • Introduced in: 9.8

v41.throughput.write

integer

query

False

Filter by v41.throughput.write

  • Introduced in: 9.8

v41.throughput.read

integer

query

False

Filter by v41.throughput.read

  • Introduced in: 9.8

v41.duration

string

query

False

Filter by v41.duration

  • Introduced in: 9.8

v41.status

string

query

False

Filter by v41.status

  • Introduced in: 9.8

v3.status

string

query

False

Filter by v3.status

v3.duration

string

query

False

Filter by v3.duration

v3.throughput.total

integer

query

False

Filter by v3.throughput.total

v3.throughput.write

integer

query

False

Filter by v3.throughput.write

v3.throughput.read

integer

query

False

Filter by v3.throughput.read

v3.latency.write

integer

query

False

Filter by v3.latency.write

v3.latency.read

integer

query

False

Filter by v3.latency.read

v3.latency.other

integer

query

False

Filter by v3.latency.other

v3.latency.total

integer

query

False

Filter by v3.latency.total

v3.iops.write

integer

query

False

Filter by v3.iops.write

v3.iops.read

integer

query

False

Filter by v3.iops.read

v3.iops.other

integer

query

False

Filter by v3.iops.other

v3.iops.total

integer

query

False

Filter by v3.iops.total

timestamp

string

query

False

Filter by timestamp

svm.uuid

string

path

True

Unique identifier of the SVM.

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"
    }
  },
  "num_records": 1,
  "records": [
    {
      "v3": {
        "_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-25 06:20:13 -0500"
      },
      "v4": {
        "_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-25 06:20:13 -0500"
      },
      "v41": {
        "_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-25 06:20:13 -0500"
      }
    }
  ]
}

Error