Report cluster-wide storage details across different tiers
Retrieves comprehensive cluster-wide storage details across various tiers, including information on storage efficiency, block storage, and cloud storage. This endpoint helps you understand the overall storage configuration and utilization within your cluster.
HTTP method and endpoint
GET /storage/cluster
Introduced in
ONTAP 9.6
Usage notes
Retrieves cluster-wide storage details across the different tiers. By default, this endpoint returns all fields. Storage details include storage efficiency, block storage and cloud storage information. Supports the following roles: admin, and readonly.
Related ONTAP commands
-
cluster space show
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
efficiency.savings |
integer |
query |
False |
Filter by efficiency.savings
|
efficiency.logical_used |
integer |
query |
False |
Filter by efficiency.logical_used
|
efficiency.ratio |
number |
query |
False |
Filter by efficiency.ratio
|
efficiency_without_snapshots.savings |
integer |
query |
False |
Filter by efficiency_without_snapshots.savings
|
efficiency_without_snapshots.logical_used |
integer |
query |
False |
Filter by efficiency_without_snapshots.logical_used
|
efficiency_without_snapshots.ratio |
number |
query |
False |
Filter by efficiency_without_snapshots.ratio
|
efficiency_without_snapshots_flexclones.savings |
integer |
query |
False |
Filter by efficiency_without_snapshots_flexclones.savings
|
efficiency_without_snapshots_flexclones.logical_used |
integer |
query |
False |
Filter by efficiency_without_snapshots_flexclones.logical_used
|
efficiency_without_snapshots_flexclones.ratio |
number |
query |
False |
Filter by efficiency_without_snapshots_flexclones.ratio
|
cloud_storage.used |
integer |
query |
False |
Filter by cloud_storage.used
|
block_storage.medias.size |
integer |
query |
False |
Filter by block_storage.medias.size
|
block_storage.medias.used |
integer |
query |
False |
Filter by block_storage.medias.used
|
block_storage.medias.available |
integer |
query |
False |
Filter by block_storage.medias.available
|
block_storage.medias.type |
string |
query |
False |
Filter by block_storage.medias.type
|
block_storage.medias.efficiency_without_snapshots_flexclones.savings |
integer |
query |
False |
Filter by block_storage.medias.efficiency_without_snapshots_flexclones.savings
|
block_storage.medias.efficiency_without_snapshots_flexclones.logical_used |
integer |
query |
False |
Filter by block_storage.medias.efficiency_without_snapshots_flexclones.logical_used
|
block_storage.medias.efficiency_without_snapshots_flexclones.ratio |
number |
query |
False |
Filter by block_storage.medias.efficiency_without_snapshots_flexclones.ratio
|
block_storage.medias.efficiency.savings |
integer |
query |
False |
Filter by block_storage.medias.efficiency.savings
|
block_storage.medias.efficiency.logical_used |
integer |
query |
False |
Filter by block_storage.medias.efficiency.logical_used
|
block_storage.medias.efficiency.ratio |
number |
query |
False |
Filter by block_storage.medias.efficiency.ratio
|
block_storage.medias.efficiency_without_snapshots.savings |
integer |
query |
False |
Filter by block_storage.medias.efficiency_without_snapshots.savings
|
block_storage.medias.efficiency_without_snapshots.logical_used |
integer |
query |
False |
Filter by block_storage.medias.efficiency_without_snapshots.logical_used
|
block_storage.medias.efficiency_without_snapshots.ratio |
number |
query |
False |
Filter by block_storage.medias.efficiency_without_snapshots.ratio
|
block_storage.medias.physical_used |
integer |
query |
False |
Filter by block_storage.medias.physical_used
|
block_storage.physical_used |
integer |
query |
False |
Filter by block_storage.physical_used
|
block_storage.inactive_data |
integer |
query |
False |
Filter by block_storage.inactive_data
|
block_storage.available |
integer |
query |
False |
Filter by block_storage.available
|
block_storage.size |
integer |
query |
False |
Filter by block_storage.size
|
block_storage.used |
integer |
query |
False |
Filter by block_storage.used
|
fields |
array[string] |
query |
False |
Specify the fields to return. |
Response
Status: 200, Ok
| Name | Type | Description |
|---|---|---|
block_storage |
Configuration information for the locally attached portion of the storage across the cluster. When a cloud store is also used by the storage, this is referred to as the performance tier. |
|
cloud_storage |
Configuration information for the cloud storage portion of all the aggregates across the cluster. This is referred to as the capacity tier. |
|
efficiency |
Storage efficiency. |
|
efficiency_without_snapshots |
Storage efficiency that does not include the savings provided by snapshots. |
|
efficiency_without_snapshots_flexclones |
Storage efficiency that does not include the savings provided by snapshots and FlexClone volumes. |
|
metric |
Cluster capacity numbers, such as total size, used size, and available size. |
Example response
{
"block_storage": {
"available": 0,
"inactive_data": 0,
"medias": [
{
"efficiency": {
"logical_used": 0,
"ratio": 0,
"savings": 0
},
"efficiency_without_snapshots": {
"logical_used": 0,
"ratio": 0,
"savings": 0
},
"efficiency_without_snapshots_flexclones": {
"logical_used": 0,
"ratio": 0,
"savings": 0
},
"type": "string"
}
],
"physical_used": 0,
"size": 0,
"used": 0
},
"efficiency": {
"logical_used": 0,
"ratio": 0,
"savings": 0
},
"efficiency_without_snapshots": {
"logical_used": 0,
"ratio": 0,
"savings": 0
},
"efficiency_without_snapshots_flexclones": {
"logical_used": 0,
"ratio": 0,
"savings": 0
},
"metric": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
}
}
}
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
efficiency
Storage efficiency.
| Name | Type | Description |
|---|---|---|
logical_used |
integer |
Logical used |
ratio |
number |
Data reduction ratio (logical_used / used) |
savings |
integer |
Space saved by storage efficiencies (logical_used - used) |
efficiency_without_snapshots
Storage efficiency that does not include the savings provided by snapshots.
| Name | Type | Description |
|---|---|---|
logical_used |
integer |
Logical used |
ratio |
number |
Data reduction ratio (logical_used / used) |
savings |
integer |
Space saved by storage efficiencies (logical_used - used) |
efficiency_without_snapshots_flexclones
Storage efficiency that does not include the savings provided by snapshots and FlexClone volumes.
| Name | Type | Description |
|---|---|---|
logical_used |
integer |
Logical used |
ratio |
number |
Data reduction ratio (logical_used / used) |
savings |
integer |
Space saved by storage efficiencies (logical_used - used) |
medias
| Name | Type | Description |
|---|---|---|
available |
integer |
Available space across the cluster based on media type. |
efficiency |
Storage efficiency. |
|
efficiency_without_snapshots |
Storage efficiency that does not include the savings provided by snapshots. |
|
efficiency_without_snapshots_flexclones |
Storage efficiency that does not include the savings provided by snapshots and FlexClone volumes. |
|
physical_used |
integer |
Total physical used space across the cluster based on media type. |
size |
integer |
Total space across the cluster based on media type. |
type |
string |
The type of media being used. |
used |
integer |
Used space across the cluster based on media type. |
block_storage
Configuration information for the locally attached portion of the storage across the cluster. When a cloud store is also used by the storage, this is referred to as the performance tier.
| Name | Type | Description |
|---|---|---|
available |
integer |
Available space across the cluster. |
inactive_data |
integer |
Inactive data across the cluster. |
medias |
array[medias] |
Configuration information based on type of media. For example, SSD media type information includes the sum of all the SSD storage across the cluster. |
physical_used |
integer |
Total physical used space across the cluster. |
size |
integer |
Total space across the cluster. |
used |
integer |
Used space (includes volume reserves) across the cluster. |
cloud_storage
Configuration information for the cloud storage portion of all the aggregates across the cluster. This is referred to as the capacity tier.
| Name | Type | Description |
|---|---|---|
used |
integer |
Total space used in cloud. |
href
| Name | Type | Description |
|---|---|---|
href |
string |
_links
| Name | Type | Description |
|---|---|---|
self |
metric
Cluster capacity numbers, such as total size, used size, and available size.
| Name | Type | Description |
|---|---|---|
_links |
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
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. |