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

Retrieve a collection of disks

Contributors
PDFs

GET /storage/disks

Introduced In: 9.6

Retrieves a collection of disks.

  • storage disk show

Learn more

Parameters

Name Type In Required Description

physical_size

integer

query

False

Filter by physical_size

  • Introduced in: 9.11

key_id.data

string

query

False

Filter by key_id.data

  • Introduced in: 9.7

key_id.fips

string

query

False

Filter by key_id.fips

  • Introduced in: 9.7

outage.persistently_failed

boolean

query

False

Filter by outage.persistently_failed

  • Introduced in: 9.9

outage.reason.code

string

query

False

Filter by outage.reason.code

  • Introduced in: 9.9

outage.reason.arguments.code

string

query

False

Filter by outage.reason.arguments.code

  • Introduced in: 9.10

outage.reason.arguments.message

string

query

False

Filter by outage.reason.arguments.message

  • Introduced in: 9.10

outage.reason.message

string

query

False

Filter by outage.reason.message

  • Introduced in: 9.9

error.type

string

query

False

Filter by error.type

  • Introduced in: 9.9

error.reason.code

string

query

False

Filter by error.reason.code

  • Introduced in: 9.9

error.reason.arguments.code

string

query

False

Filter by error.reason.arguments.code

  • Introduced in: 9.10

error.reason.arguments.message

string

query

False

Filter by error.reason.arguments.message

  • Introduced in: 9.10

error.reason.message

string

query

False

Filter by error.reason.message

  • Introduced in: 9.9

virtual.object

string

query

False

Filter by virtual.object

  • Introduced in: 9.11

virtual.storage_account

string

query

False

Filter by virtual.storage_account

  • Introduced in: 9.11

virtual.target_address

string

query

False

Filter by virtual.target_address

  • Introduced in: 9.13

virtual.container

string

query

False

Filter by virtual.container

  • Introduced in: 9.11

protection_mode

string

query

False

Filter by protection_mode

  • Introduced in: 9.7

fips_certified

boolean

query

False

Filter by fips_certified

  • Introduced in: 9.7

compliance_standard

string

query

False

Filter by compliance_standard

  • Introduced in: 9.11

vendor

string

query

False

Filter by vendor

storage_pool.uuid

string

query

False

Filter by storage_pool.uuid

  • Introduced in: 9.11

storage_pool.name

string

query

False

Filter by storage_pool.name

  • Introduced in: 9.11

overall_security

string

query

False

Filter by overall_security

  • Introduced in: 9.11

paths.wwnn

string

query

False

Filter by paths.wwnn

  • Introduced in: 9.9

paths.node.uuid

string

query

False

Filter by paths.node.uuid

  • Introduced in: 9.11

paths.node.name

string

query

False

Filter by paths.node.name

  • Introduced in: 9.11

paths.port_name

string

query

False

Filter by paths.port_name

  • Introduced in: 9.9

paths.vmdisk_hypervisor_file_name

string

query

False

Filter by paths.vmdisk_hypervisor_file_name

  • Introduced in: 9.11

paths.initiator

string

query

False

Filter by paths.initiator

  • Introduced in: 9.9

paths.port_type

string

query

False

Filter by paths.port_type

  • Introduced in: 9.9

paths.disk_path_name

string

query

False

Filter by paths.disk_path_name

  • Introduced in: 9.14

paths.wwpn

string

query

False

Filter by paths.wwpn

  • Introduced in: 9.9

firmware_version

string

query

False

Filter by firmware_version

rpm

integer

query

False

Filter by rpm

right_size_sector_count

integer

query

False

Filter by right_size_sector_count

  • Introduced in: 9.11

effective_type

string

query

False

Filter by effective_type

  • Introduced in: 9.9

name

string

query

False

Filter by name

control_standard

string

query

False

Filter by control_standard

  • Introduced in: 9.11

home_node.name

string

query

False

Filter by home_node.name

home_node.uuid

string

query

False

Filter by home_node.uuid

drawer.slot

integer

query

False

Filter by drawer.slot

drawer.id

integer

query

False

Filter by drawer.id

sector_count

integer

query

False

Filter by sector_count

  • Introduced in: 9.9

bytes_per_sector

integer

query

False

Filter by bytes_per_sector

  • Introduced in: 9.9

pool

string

query

False

Filter by pool

uid

string

query

False

Filter by uid

self_encrypting

boolean

query

False

Filter by self_encrypting

  • Introduced in: 9.7

type

string

query

False

Filter by type

shelf.uid

string

query

False

Filter by shelf.uid

location

string

query

False

Filter by location

  • Introduced in: 9.14

serial_number

string

query

False

Filter by serial_number

model

string

query

False

Filter by model

container_type

string

query

False

Filter by container_type

aggregates.uuid

string

query

False

Filter by aggregates.uuid

aggregates.name

string

query

False

Filter by aggregates.name

node.name

string

query

False

Filter by node.name

node.uuid

string

query

False

Filter by node.uuid

usable_size

integer

query

False

Filter by usable_size

bay

integer

query

False

Filter by bay

dr_node.uuid

string

query

False

Filter by dr_node.uuid

dr_node.name

string

query

False

Filter by dr_node.name

stats.path_error_count

integer

query

False

Filter by stats.path_error_count

  • Introduced in: 9.9

stats.average_latency

integer

query

False

Filter by stats.average_latency

  • Introduced in: 9.9

stats.power_on_hours

integer

query

False

Filter by stats.power_on_hours

  • Introduced in: 9.9

stats.throughput

integer

query

False

Filter by stats.throughput

  • Introduced in: 9.9

stats.iops_total

integer

query

False

Filter by stats.iops_total

  • Introduced in: 9.9

state

string

query

False

Filter by state

local

boolean

query

False

Filter by local

  • Introduced in: 9.9

rated_life_used_percent

integer

query

False

Filter by rated_life_used_percent

class

string

query

False

Filter by class

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

Number of records

records

array[disk]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "aggregates": [
        {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "name": "aggr1",
          "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
        }
      ],
      "bay": 1,
      "bytes_per_sector": 520,
      "class": "solid_state",
      "compliance_standard": "FIPS 140-2",
      "container_type": "spare",
      "control_standard": "TCG Enterprise",
      "dr_node": {
        "name": "node1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "effective_type": "vmdisk",
      "encryption_operation": "string",
      "error": [
        {
          "reason": {
            "arguments": [
              {
                "code": "string",
                "message": "string"
              }
            ],
            "code": "4",
            "message": "entry doesn't exist"
          },
          "type": "notallflashdisk"
        }
      ],
      "firmware_version": "NA51",
      "home_node": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "node1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "key_id": {
        "data": "string",
        "fips": "string"
      },
      "location": "node-01",
      "model": "X421_HCOBE450A10",
      "name": "1.0.1",
      "node": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "node1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "outage": {
        "reason": {
          "arguments": [
            {
              "code": "string",
              "message": "string"
            }
          ],
          "code": "4",
          "message": "entry doesn't exist"
        }
      },
      "overall_security": "Level 2",
      "paths": [
        {
          "disk_path_name": "vsim4:3a.10",
          "initiator": "3a",
          "node.name": "vsim4",
          "node.uuid": "cf7fe057-526d-11ec-af4e-0050568e9df0",
          "port_name": "A",
          "port_type": "sas",
          "vmdisk_hypervisor_file_name": "xvds vol0a0567ae156ca59f6",
          "wwnn": "5000c2971c1b2b8c",
          "wwpn": "5000c2971c1b2b8d"
        }
      ],
      "physical_size": 228930,
      "pool": "pool0",
      "protection_mode": "data",
      "rated_life_used_percent": 10,
      "right_size_sector_count": 1172123568,
      "rpm": 15000,
      "sector_count": 1172123568,
      "serial_number": "KHG2VX8R",
      "shelf": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "uid": "7777841915827391056"
      },
      "state": "present",
      "stats": {
        "average_latency": 3,
        "iops_total": 12854,
        "path_error_count": 0,
        "power_on_hours": 21016,
        "throughput": 1957888
      },
      "storage_pool": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "storage_pool_1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "type": "ssd",
      "uid": "002538E5:71B00B2F:00000000:00000000:00000000:00000000:00000000:00000000:00000000:00000000",
      "usable_size": 959934889984,
      "vendor": "NETAPP",
      "virtual": {
        "container": "nviet12122018113936-rg",
        "object": "f1fu63se",
        "storage_account": "nviet12122018113936ps",
        "target_address": "string"
      }
    }
  ]
}

Error

Status: Default, Error
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

aggregates

Aggregate

Name Type Description

_links

_links

name

string

uuid

string

dr_node

Name Type Description

name

string

uuid

string

drawer

Name Type Description

id

integer

slot

integer

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

The message and code detailing the error state of this disk.

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

disk_error_info

Name Type Description

reason

error

The message and code detailing the error state of this disk.

type

string

Disk error type.

home_node

Name Type Description

_links

_links

name

string

uuid

string

key_id

Name Type Description

data

string

Key ID of the data authentication key

fips

string

Key ID of the FIPS authentication key

node

Name Type Description

_links

_links

name

string

uuid

string

error

This error message and code explaining the disk failure.

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

outage

Indicates if a disk has an entry in the failed disk registry, along with the reason for the failure.

Name Type Description

persistently_failed

boolean

Indicates whether RAID maintains the state of this disk as failed across reboots.

reason

error

This error message and code explaining the disk failure.

disk_path_info

Name Type Description

disk_path_name

string

Path-based disk name.

initiator

string

Initiator port.

node.name

string

Controller with the initiator port for this path.

node.uuid

string

Controller UUID, to identify node for this path.

port_name

string

Name of the disk port.

port_type

string

Disk port type.

vmdisk_hypervisor_file_name

string

Virtual disk hypervisor file name.

wwnn

string

Target device's World Wide Node Name.

wwpn

string

Target device's World Wide Port Name.

shelf

Shelf

Name Type Description

_links

_links

uid

string

stats

Name Type Description

average_latency

integer

Average I/O latency across all active paths, in milliseconds.

iops_total

integer

Total I/O operations per second read and written to this disk across all active paths.

path_error_count

integer

Disk path error count; failed I/O operations.

power_on_hours

integer

Hours powered on.

throughput

integer

Total disk throughput per second across all active paths, in bytes.

storage_pool

Shared Storage Pool

Name Type Description

_links

_links

name

string

uuid

string

virtual

Information about backing storage for disks on cloud platforms.

Name Type Description

container

string

Container name of the virtual disk.

object

string

Object name of the virtual disk.

storage_account

string

Storage account name of the virtual disk.

target_address

string

Target address of the virtual disk.

disk

Name Type Description

aggregates

array[aggregates]

List of aggregates sharing this disk

bay

integer

Disk shelf bay

bytes_per_sector

integer

Bytes per sector.

class

string

Disk class

compliance_standard

string

Security standard that the device is certified to.

container_type

string

Type of overlying disk container

control_standard

string

Standard that the device supports for encryption control.

dr_node

dr_node

drawer

drawer

effective_type

string

Effective Disk type

encryption_operation

string

This field should only be set as a query parameter in a PATCH operation. It is input only and won't be returned by a subsequent GET.

error

array[disk_error_info]

List of disk errors information.

fips_certified

boolean

firmware_version

string

home_node

home_node

key_id

key_id

local

boolean

Indicates if a disk is locally attached versus being remotely attached. A locally attached disk resides in the same proximity as the host cluster versus been attached to the remote cluster.

location

string

Physical location of the disk

model

string

name

string

Cluster-wide disk name

node

node

outage

outage

Indicates if a disk has an entry in the failed disk registry, along with the reason for the failure.

overall_security

string

Overall Security rating, for FIPS-certified devices.

paths

array[disk_path_info]

List of paths to a disk

physical_size

integer

Physical size, in units of bytes

pool

string

Pool to which disk is assigned

protection_mode

string

Mode of drive data protection and FIPS compliance. Possible values are:

  • open - Data is unprotected

  • data - Data protection only, without FIPS compliance

  • part - Data is unprotected; other FIPS compliance settings present

  • full - Full data and FIPS compliance protection

  • miss - Protection mode information is not available

rated_life_used_percent

integer

Percentage of rated life used

right_size_sector_count

integer

Number of usable disk sectors that remain after subtracting the right-size adjustment for this disk.

rpm

integer

Revolutions per minute

sector_count

integer

Number of sectors on the disk.

self_encrypting

boolean

serial_number

string

shelf

shelf

Shelf

state

string

State

stats

stats

storage_pool

storage_pool

Shared Storage Pool

type

string

Disk interface type

uid

string

The unique identifier for a disk

usable_size

integer

vendor

string

virtual

virtual

Information about backing storage for disks on cloud platforms.

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