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

Retrieve NVMe services

Contributors
PDFs

GET /protocols/nvme/services

Introduced In: 9.6

Retrieves NVMe services.

Expensive properties

There is an added computational cost to retrieving values for these properties. They are not included by default in GET results and must be explicitly requested using the fields query parameter. See Requesting specific fields to learn more.

  • statistics.*

  • metric.*

  • vserver nvme show

Learn more

Parameters

Name Type In Required Description

enabled

boolean

query

False

Filter by enabled

statistics.fc.latency_raw.read

integer

query

False

Filter by statistics.fc.latency_raw.read

  • Introduced in: 9.10

statistics.fc.latency_raw.other

integer

query

False

Filter by statistics.fc.latency_raw.other

  • Introduced in: 9.10

statistics.fc.latency_raw.write

integer

query

False

Filter by statistics.fc.latency_raw.write

  • Introduced in: 9.10

statistics.fc.latency_raw.total

integer

query

False

Filter by statistics.fc.latency_raw.total

  • Introduced in: 9.10

statistics.fc.iops_raw.read

integer

query

False

Filter by statistics.fc.iops_raw.read

  • Introduced in: 9.10

statistics.fc.iops_raw.other

integer

query

False

Filter by statistics.fc.iops_raw.other

  • Introduced in: 9.10

statistics.fc.iops_raw.write

integer

query

False

Filter by statistics.fc.iops_raw.write

  • Introduced in: 9.10

statistics.fc.iops_raw.total

integer

query

False

Filter by statistics.fc.iops_raw.total

  • Introduced in: 9.10

statistics.fc.status

string

query

False

Filter by statistics.fc.status

  • Introduced in: 9.10

statistics.fc.timestamp

string

query

False

Filter by statistics.fc.timestamp

  • Introduced in: 9.10

statistics.fc.throughput_raw.total

integer

query

False

Filter by statistics.fc.throughput_raw.total

  • Introduced in: 9.10

statistics.fc.throughput_raw.write

integer

query

False

Filter by statistics.fc.throughput_raw.write

  • Introduced in: 9.10

statistics.fc.throughput_raw.read

integer

query

False

Filter by statistics.fc.throughput_raw.read

  • Introduced in: 9.10

statistics.latency_raw.read

integer

query

False

Filter by statistics.latency_raw.read

  • Introduced in: 9.7

statistics.latency_raw.other

integer

query

False

Filter by statistics.latency_raw.other

  • Introduced in: 9.7

statistics.latency_raw.write

integer

query

False

Filter by statistics.latency_raw.write

  • Introduced in: 9.7

statistics.latency_raw.total

integer

query

False

Filter by statistics.latency_raw.total

  • Introduced in: 9.7

statistics.iops_raw.read

integer

query

False

Filter by statistics.iops_raw.read

  • Introduced in: 9.7

statistics.iops_raw.other

integer

query

False

Filter by statistics.iops_raw.other

  • Introduced in: 9.7

statistics.iops_raw.write

integer

query

False

Filter by statistics.iops_raw.write

  • Introduced in: 9.7

statistics.iops_raw.total

integer

query

False

Filter by statistics.iops_raw.total

  • Introduced in: 9.7

statistics.status

string

query

False

Filter by statistics.status

  • Introduced in: 9.7

statistics.timestamp

string

query

False

Filter by statistics.timestamp

  • Introduced in: 9.7

statistics.throughput_raw.total

integer

query

False

Filter by statistics.throughput_raw.total

  • Introduced in: 9.7

statistics.throughput_raw.write

integer

query

False

Filter by statistics.throughput_raw.write

  • Introduced in: 9.7

statistics.throughput_raw.read

integer

query

False

Filter by statistics.throughput_raw.read

  • Introduced in: 9.7

statistics.tcp.latency_raw.read

integer

query

False

Filter by statistics.tcp.latency_raw.read

  • Introduced in: 9.10

statistics.tcp.latency_raw.other

integer

query

False

Filter by statistics.tcp.latency_raw.other

  • Introduced in: 9.10

statistics.tcp.latency_raw.write

integer

query

False

Filter by statistics.tcp.latency_raw.write

  • Introduced in: 9.10

statistics.tcp.latency_raw.total

integer

query

False

Filter by statistics.tcp.latency_raw.total

  • Introduced in: 9.10

statistics.tcp.iops_raw.read

integer

query

False

Filter by statistics.tcp.iops_raw.read

  • Introduced in: 9.10

statistics.tcp.iops_raw.other

integer

query

False

Filter by statistics.tcp.iops_raw.other

  • Introduced in: 9.10

statistics.tcp.iops_raw.write

integer

query

False

Filter by statistics.tcp.iops_raw.write

  • Introduced in: 9.10

statistics.tcp.iops_raw.total

integer

query

False

Filter by statistics.tcp.iops_raw.total

  • Introduced in: 9.10

statistics.tcp.status

string

query

False

Filter by statistics.tcp.status

  • Introduced in: 9.10

statistics.tcp.timestamp

string

query

False

Filter by statistics.tcp.timestamp

  • Introduced in: 9.10

statistics.tcp.throughput_raw.total

integer

query

False

Filter by statistics.tcp.throughput_raw.total

  • Introduced in: 9.10

statistics.tcp.throughput_raw.write

integer

query

False

Filter by statistics.tcp.throughput_raw.write

  • Introduced in: 9.10

statistics.tcp.throughput_raw.read

integer

query

False

Filter by statistics.tcp.throughput_raw.read

  • Introduced in: 9.10

metric.duration

string

query

False

Filter by metric.duration

  • Introduced in: 9.7

metric.throughput.total

integer

query

False

Filter by metric.throughput.total

  • Introduced in: 9.7

metric.throughput.write

integer

query

False

Filter by metric.throughput.write

  • Introduced in: 9.7

metric.throughput.read

integer

query

False

Filter by metric.throughput.read

  • Introduced in: 9.7

metric.fc.duration

string

query

False

Filter by metric.fc.duration

  • Introduced in: 9.10

metric.fc.throughput.total

integer

query

False

Filter by metric.fc.throughput.total

  • Introduced in: 9.10

metric.fc.throughput.write

integer

query

False

Filter by metric.fc.throughput.write

  • Introduced in: 9.10

metric.fc.throughput.read

integer

query

False

Filter by metric.fc.throughput.read

  • Introduced in: 9.10

metric.fc.status

string

query

False

Filter by metric.fc.status

  • Introduced in: 9.10

metric.fc.timestamp

string

query

False

Filter by metric.fc.timestamp

  • Introduced in: 9.10

metric.fc.iops.read

integer

query

False

Filter by metric.fc.iops.read

  • Introduced in: 9.10

metric.fc.iops.other

integer

query

False

Filter by metric.fc.iops.other

  • Introduced in: 9.10

metric.fc.iops.write

integer

query

False

Filter by metric.fc.iops.write

  • Introduced in: 9.10

metric.fc.iops.total

integer

query

False

Filter by metric.fc.iops.total

  • Introduced in: 9.10

metric.fc.latency.read

integer

query

False

Filter by metric.fc.latency.read

  • Introduced in: 9.10

metric.fc.latency.other

integer

query

False

Filter by metric.fc.latency.other

  • Introduced in: 9.10

metric.fc.latency.write

integer

query

False

Filter by metric.fc.latency.write

  • Introduced in: 9.10

metric.fc.latency.total

integer

query

False

Filter by metric.fc.latency.total

  • Introduced in: 9.10

metric.latency.read

integer

query

False

Filter by metric.latency.read

  • Introduced in: 9.7

metric.latency.other

integer

query

False

Filter by metric.latency.other

  • Introduced in: 9.7

metric.latency.write

integer

query

False

Filter by metric.latency.write

  • Introduced in: 9.7

metric.latency.total

integer

query

False

Filter by metric.latency.total

  • Introduced in: 9.7

metric.tcp.duration

string

query

False

Filter by metric.tcp.duration

  • Introduced in: 9.10

metric.tcp.throughput.total

integer

query

False

Filter by metric.tcp.throughput.total

  • Introduced in: 9.10

metric.tcp.throughput.write

integer

query

False

Filter by metric.tcp.throughput.write

  • Introduced in: 9.10

metric.tcp.throughput.read

integer

query

False

Filter by metric.tcp.throughput.read

  • Introduced in: 9.10

metric.tcp.status

string

query

False

Filter by metric.tcp.status

  • Introduced in: 9.10

metric.tcp.timestamp

string

query

False

Filter by metric.tcp.timestamp

  • Introduced in: 9.10

metric.tcp.iops.read

integer

query

False

Filter by metric.tcp.iops.read

  • Introduced in: 9.10

metric.tcp.iops.other

integer

query

False

Filter by metric.tcp.iops.other

  • Introduced in: 9.10

metric.tcp.iops.write

integer

query

False

Filter by metric.tcp.iops.write

  • Introduced in: 9.10

metric.tcp.iops.total

integer

query

False

Filter by metric.tcp.iops.total

  • Introduced in: 9.10

metric.tcp.latency.read

integer

query

False

Filter by metric.tcp.latency.read

  • Introduced in: 9.10

metric.tcp.latency.other

integer

query

False

Filter by metric.tcp.latency.other

  • Introduced in: 9.10

metric.tcp.latency.write

integer

query

False

Filter by metric.tcp.latency.write

  • Introduced in: 9.10

metric.tcp.latency.total

integer

query

False

Filter by metric.tcp.latency.total

  • Introduced in: 9.10

metric.timestamp

string

query

False

Filter by metric.timestamp

  • Introduced in: 9.7

metric.status

string

query

False

Filter by metric.status

  • Introduced in: 9.7

metric.iops.read

integer

query

False

Filter by metric.iops.read

  • Introduced in: 9.7

metric.iops.other

integer

query

False

Filter by metric.iops.other

  • Introduced in: 9.7

metric.iops.write

integer

query

False

Filter by metric.iops.write

  • Introduced in: 9.7

metric.iops.total

integer

query

False

Filter by metric.iops.total

  • Introduced in: 9.7

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

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

num_records

integer

The number of records in the response.

records

array[nvme_service]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "metric": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "duration": "PT15S",
        "fc": {
          "_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"
        },
        "iops": {
          "read": 200,
          "total": 1000,
          "write": 100
        },
        "latency": {
          "read": 200,
          "total": 1000,
          "write": 100
        },
        "status": "ok",
        "tcp": {
          "_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"
        },
        "throughput": {
          "read": 200,
          "total": 1000,
          "write": 100
        },
        "timestamp": "2017-01-25 06:20:13 -0500"
      },
      "statistics": {
        "fc": {
          "iops_raw": {
            "read": 200,
            "total": 1000,
            "write": 100
          },
          "latency_raw": {
            "read": 200,
            "total": 1000,
            "write": 100
          },
          "status": "ok",
          "throughput_raw": {
            "read": 200,
            "total": 1000,
            "write": 100
          },
          "timestamp": "2017-01-25 06:20:13 -0500"
        },
        "iops_raw": {
          "read": 200,
          "total": 1000,
          "write": 100
        },
        "latency_raw": {
          "read": 200,
          "total": 1000,
          "write": 100
        },
        "status": "ok",
        "tcp": {
          "iops_raw": {
            "read": 200,
            "total": 1000,
            "write": 100
          },
          "latency_raw": {
            "read": 200,
            "total": 1000,
            "write": 100
          },
          "status": "ok",
          "throughput_raw": {
            "read": 200,
            "total": 1000,
            "write": 100
          },
          "timestamp": "2017-01-25 06:20:13 -0500"
        },
        "throughput_raw": {
          "read": 200,
          "total": 1000,
          "write": 100
        },
        "timestamp": "2017-01-25 06:20:13 -0500"
      },
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      }
    }
  ]
}

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

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.

fc

The NVMe/FC portion of the aggregated metrics.

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

Any errors associated with the sample. For example, if the aggregation of data over multiple nodes fails then any of the partial errors might be returned, "ok" on success, or "error" on any 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.

tcp

The NVMe/TCP portion of the aggregated metrics.

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

Any errors associated with the sample. For example, if the aggregation of data over multiple nodes fails then any of the partial errors might be returned, "ok" on success, or "error" on any 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