REST API reference
Retrieve a specific disk
Suggest changes
PDFs
GET /storage/disks/{name}
Retrieves a specific disk.
Related ONTAP commands
-
storage disk show
Learn more
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
name |
string |
path |
True |
Disk name |
fields |
array[string] |
query |
False |
Specify the fields to return. |
Response
Status: 200, Ok| Name | Type | Description |
|---|---|---|
aggregates |
array[aggregates] |
List of aggregates sharing this disk |
bay |
string |
Disk shelf bay |
class |
string |
Disk class |
container_type |
string |
Type of overlying disk container |
dr_node |
||
drawer |
||
firmware_version |
string |
|
home_node |
||
model |
string |
|
name |
string |
Cluster-wide disk name |
node |
||
pool |
string |
Pool to which disk is assigned |
rated_life_used_percent |
integer |
Percentage of rated life used |
rpm |
integer |
Revolutions per minute |
serial_number |
string |
|
shelf |
Shelf |
|
state |
string |
State |
type |
string |
Disk interface type |
uid |
string |
The unique identifier for a disk |
usable_size |
integer |
|
vendor |
string |
Example response
{
"aggregates": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "aggr1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}
],
"bay": 1,
"class": "solid_state",
"container_type": "spare",
"dr_node": {
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"firmware_version": "NA51",
"home_node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"model": "X421_HCOBE450A10",
"name": "1.0.1",
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"pool": "pool0",
"rated_life_used_percent": 10,
"rpm": 15000,
"serial_number": "KHG2VX8R",
"shelf": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"uid": 7777841915827391056
},
"state": "present",
"type": "ssd",
"uid": "002538E5:71B00B2F:00000000:00000000:00000000:00000000:00000000:00000000:00000000:00000000",
"usable_size": 959934889984,
"vendor": "NETAPP"
}Error
Status: Default, Error| Name | Type | Description |
|---|---|---|
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 |
|---|---|---|
self |
aggregates
Aggregate
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
uuid |
string |
dr_node
| Name | Type | Description |
|---|---|---|
name |
string |
|
uuid |
string |
drawer
| Name | Type | Description |
|---|---|---|
id |
integer |
|
slot |
integer |
home_node
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
uuid |
string |
node
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
uuid |
string |
shelf_reference
Shelf
| Name | Type | Description |
|---|---|---|
_links |
||
uid |
string |
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. |