Retrieve aggregates
Suggest changes
GET /onprem/aggregates
Retrieves aggregates.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
workingEnvironmentId |
string |
query |
False |
|
checkTieringRestrictions |
boolean |
query |
False |
Error
Status: Default, Default response| Name | Type | Required | Description |
|---|---|---|---|
availabilityState |
string |
False |
|
availableCapacity |
False |
||
commonDiskProperties |
False |
||
isInactiveDataReportingEnabled |
boolean |
True |
|
isObjectStoreAttachEligible |
boolean |
False |
|
name |
string |
True |
|
objectStoreName |
string |
False |
|
snaplockType |
string |
True |
Snaplock type |
state |
string |
False |
|
tieringRestriction |
False |
||
totalCapacity |
True |
||
usedCapacity |
False |
Example error response
{
"availabilityState": "string",
"availableCapacity": {
"size": 0,
"unit": "string"
},
"commonDiskProperties": {
"diskType": "string"
},
"isInactiveDataReportingEnabled": false,
"name": "string",
"objectStoreName": "string",
"snaplockType": "string",
"state": "string",
"tieringRestriction": {
"restrictionReason": "string"
},
"totalCapacity": {
"size": 0,
"unit": "string"
},
"usedCapacity": {
"size": 0,
"unit": "string"
}
}Definitions
See Definitions
Capacity
| Name | Type | Required | Description |
|---|---|---|---|
size |
number |
True |
Size |
unit |
string |
True |
Unit |
rpm
CommonDiskProperties
| Name | Type | Required | Description |
|---|---|---|---|
diskType |
string |
False |
|
rpm |
False |
||
sizeKB |
integer |
False |
TieringRestriction
| Name | Type | Required | Description |
|---|---|---|---|
isTieringRestricted |
boolean |
False |
|
restrictionReason |
string |
False |