Skip to main content

Retrieve aggregates

GET /aws/ha/aggregates

Retrieves aggregates.

Parameters

Name Type In Required Description

workingEnvironmentId

string

query

False

Error

Status: Default, Default response
Name Type Required Description

name

string

True

Aggregate name

availableCapacity

Capacity

True

totalCapacity

Capacity

True

usedCapacity

Capacity

True

volumes

array[Volume]

True

Volumes

providerVolumes

array[ProviderVolumeResponse]

True

Provider volumes

disks

array[Disk]

True

Disks

state

string

False

State

encryptionType

string

True

Encryption Type

encryptionKeyId

string

False

Encryption Key

isRoot

boolean

True

Is Root

homeNode

string

True

Home node

ownerNode

string

False

Owner node

capacityTier

string

False

Capacity tier

capacityTierUsed

Capacity

False

sidlEnabled

boolean

True

SIDL enabled

snaplockType

string

True

Snaplock type

evCompatibilityType

string

True

Elastic Volume Compatibility Type

iops

iops

False

Aggregate IOPS

Definitions

See Definitions

Capacity

Name Type Required Description

size

number

True

Size

unit

string

True

Unit

Volume

Name Type Required Description

name

string

True

Name

totalSize

Capacity

True

usedSize

Capacity

True

thinProvisioned

boolean

True

Indicates if the volume is thin-provisioned

isClone

boolean

True

Indicates if the volume is a clone volume

rootVolume

boolean

True

Indicates if the volume is the root volume of the SVM

ProviderVolumeResponse

Name Type Required Description

id

string

True

Specifies the ID

name

string

True

Specifies the name

size

Capacity

True

state

string

True

State

device

string

True

Device

instanceId

string

True

InstanceId

diskType

string

True

Type

encrypted

boolean

True

Encrypted

iops

integer

False

Provisioned IOPS

throughput

integer

False

Provisioned throughput

instance2Id

string

False

Instance2Id

VmDiskProperties

Name Type Required Description

objectName

string

False

storageAccountName

string

False

containerName

string

False

Disk

Name Type Required Description

name

string

False

Name

containerType

string

True

Container type

ownerNode

string

True

Owner node

device

string

False

Device

vmDiskProperties

VmDiskProperties

False

iops

Aggregate IOPS