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

Retrieve clients with the most I/O activity

Contributors
PDFs

GET /storage/volumes/{volume.uuid}/top-metrics/clients

Introduced In: 9.10

Retrieves a list of clients with the most IO activity.

Parameters

Name Type In Required Description

volume.uuid

string

path

True

Volume UUID

top_metric

string

query

False

IO activity type

  • Default value: 1

  • enum: ["iops.read", "iops.write", "throughput.read", "throughput.write"]

volume.name

string

query

False

Filter by volume.name

client_ip

string

query

False

Filter by client_ip

notice.message

string

query

False

Filter by notice.message

notice.code

string

query

False

Filter by notice.code

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

integer

query

False

Filter by throughput.write

throughput.read

integer

query

False

Filter by throughput.read

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

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

iops.write

integer

query

False

Filter by iops.write

iops.read

integer

query

False

Filter by iops.read

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

notice

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_client]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "notice": {
    "code": "111411207",
    "message": "No read/write traffic on volume"
  },
  "records": [
    {
      "client_ip": "192.168.185.170",
      "iops": {
        "error": {
          "lower_bound": 34,
          "upper_bound": 54
        },
        "read": 5,
        "write": 10
      },
      "notice": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "code": "111411207",
        "message": "No read/write traffic on volume."
      },
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "throughput": {
        "error": {
          "lower_bound": 34,
          "upper_bound": 54
        },
        "read": 12,
        "write": 2
      },
      "volume": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "volume1",
        "uuid": "028baa66-41bd-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

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.

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

top_metric_value_error_bounds

read

integer

Average number of read operations per second.

write

integer

Average number of write operations per second.

_links

Name Type Description

self

href

notice

Optional field that indicates why no records are returned by the volume activity tracking REST API.

Name Type Description

_links

_links

code

string

Warning code indicating why no records are returned.

message

string

Details why no records are returned.

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

throughput

Name Type Description

error

top_metric_value_error_bounds

read

integer

Average number of read bytes received per second.

write

integer

Average number of write bytes received per second.

volume

Name Type Description

_links

_links

name

string

The name of the volume.

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.

  • example: 028baa66-41bd-11e9-81d5-00a0986138f7

  • Introduced in: 9.6

top_metrics_client

Information about a client's IO activity.

Name Type Description

client_ip

string

IP address of the client. Both IPv4 and IPv6 IP addresses are supported.

iops

iops

notice

notice

Optional field that indicates why no records are returned by the volume activity tracking REST API.

svm

svm

throughput

throughput

volume

volume

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.