Skip to main content

Retrieve historical performance metrics for the FC protocol service of an SVM

Contributors
PDFs

GET /protocols/san/fcp/services/{svm.uuid}/metrics

Introduced In: 9.7

Retrieves historical performance metrics for the FC Protocol service of an SVM.

Parameters

Name Type In Required Description

throughput.total

integer

query

False

Filter by throughput.total

throughput.write

integer

query

False

Filter by throughput.write

throughput.read

integer

query

False

Filter by throughput.read

duration

string

query

False

Filter by duration

latency.write

integer

query

False

Filter by latency.write

latency.read

integer

query

False

Filter by latency.read

latency.other

integer

query

False

Filter by latency.other

latency.total

integer

query

False

Filter by latency.total

iops.write

integer

query

False

Filter by iops.write

iops.read

integer

query

False

Filter by iops.read

iops.other

integer

query

False

Filter by iops.other

iops.total

integer

query

False

Filter by iops.total

timestamp

string

query

False

Filter by timestamp

status

string

query

False

Filter by status

svm.uuid

string

path

True

The 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": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "duration": "PT15S",
      "iops": {
        "read": 200,
        "total": 1000,
        "write": 100
      },
      "latency": {
        "read": 200,
        "total": 1000,
        "write": 100
      },
      "status": "ok",
      "svm": {
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "throughput": {
        "read": 200,
        "total": 1000,
        "write": 100
      },
      "timestamp": "2017-01-25 06:20:13 -0500"
    }
  ]
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

8585947

No metrics are available for the requested object.

8586225

An unexpected error occurred retrieving metrics for the requested object.

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

_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.

svm

Name