REST API reference
Report cluster-wide storage details across different tiers
Suggest changes
-
PDF of this doc site
Collection of separate PDF docs
Creating your file...
GET /storage/cluster
Introduced In: 9.6
Reports cluster wide storage details across different tiers. By default, this endpoint returns all fields. Supports the following roles: admin, and readonly.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
fields |
array[string] |
query |
False |
Specify the fields to return. |
Response
Status: 200, Ok| Name | Type | Description |
|---|---|---|
block_storage |
||
cloud_storage |
||
efficiency |
Storage efficiency |
|
efficiency_without_snapshots |
Storage efficiency that does not include the savings provided by Snapshot copies. |
|
efficiency_without_snapshots_flexclones |
Storage efficiency that does not include the savings provided by Snapshot copies and FlexClones. |
Example response
{
"block_storage": {
"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": "hdd"
}
},
"cloud_storage": {
"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
}
}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
space_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) |
space_efficiency
Storage efficiency that does not include the savings provided by Snapshot copies.
| 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) |
space_efficiency
Storage efficiency that does not include the savings provided by Snapshot copies and FlexClones.
| 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 |
efficiency |
Storage Efficiency |
|
efficiency_without_snapshots |
Storage efficiency that does not include the savings provided by Snapshot copies. |
|
efficiency_without_snapshots_flexclones |
Storage efficiency that does not include the savings provided by Snapshot copies and FlexClones. |
|
physical_used |
integer |
Total physical used space |
size |
integer |
Total space |
type |
string |
The type of media being used |
used |
integer |
Used space |
block_storage
| Name | Type | Description |
|---|---|---|
available |
integer |
Available space across the cluster |
inactive_data |
integer |
Inactive data across all aggregates |
medias |
array[medias] |
|
physical_used |
integer |
Total physical used space across the cluster |
size |
integer |
Total space across the cluster |
used |
integer |
Space used (includes volume reserves) |
cloud_storage
| Name | Type | Description |
|---|---|---|
used |
integer |
Total space used in cloud. |
space_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) |
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. |