Skip to main content

Retrieve aggregates

GET /vsa/aggregates

Retrieves aggregates.

Parameters

Name Type In Required Description

workingEnvironmentId

string

query

False

Error

Status: Default, Default response
Name Type Required Description

availableCapacity

Capacity

True

capacityTier

string

False

Capacity tier

capacityTierUsed

Capacity

False

disks

array[Disk]

True

Disks

encryptionKeyId

string

False

Encryption Key

encryptionType

string

True

Encryption Type

evCompatibilityType

string

True

Elastic Volume Compatibility Type

homeNode

string

True

Home node

iops

iops

False

Aggregate IOPS

isRoot

boolean

True

Is Root

name

string

True

Aggregate name

ownerNode

string

False

Owner node

providerVolumes

array[ProviderVolumeResponse]

True

Provider volumes

sidlEnabled

boolean

True

SIDL enabled

snaplockType

string

True

Snaplock type

state

string

False

State

totalCapacity

Capacity

True

usedCapacity

Capacity

True

volumes

array[Volume]

True

Volumes
Example error response 
{
  "availableCapacity": {
    "size": 0,
    "unit": "string"
  },
  "capacityTier": "string",
  "capacityTierUsed": {
    "size": 0,
    "unit": "string"
  },
  "disks": [
    {
      "containerType": "string",
      "device": "string",
      "name": "string",
      "ownerNode": "string",
      "vmDiskProperties": {
        "containerName": "string",
        "objectName": "string",
        "storageAccountName": "string"
      }
    }
  ],
  "encryptionKeyId": "string",
  "encryptionType": "string",
  "evCompatibilityType": "string",
  "homeNode": "string",
  "isRoot": false,
  "name": "string",
  "ownerNode": "string",
  "providerVolumes": [
    {
      "device": "string",
      "diskType": "string",
      "encrypted": false,
      "id": "string",
      "instance2Id": "string",
      "instanceId": "string",
      "name": "string",
      "size": {
        "size": 0,
        "unit": "string"
      },
      "state": "string"
    }
  ],
  "sidlEnabled": false,
  "snaplockType": "string",
  "state": "string",
  "totalCapacity": {
    "size": 0,
    "unit": "string"
  },
  "usedCapacity": {
    "size": 0,
    "unit": "string"
  },
  "volumes": [
    {
      "isClone": false,
      "name": "string",
      "rootVolume": false,
      "thinProvisioned": false,
      "totalSize": {
        "size": 0,
        "unit": "string"
      },
      "usedSize": {
        "size": 0,
        "unit": "string"
      }
    }
  ]
}

Definitions

See Definitions

Capacity

Name Type Required Description

size

number

True

Size

unit

string

True

Unit

VmDiskProperties

Name Type Required Description

containerName

string

False

objectName

string

False

storageAccountName

string

False

Disk

Name Type Required Description

containerType

string

True

Container type

device

string

False

Device

name

string

False

Name

ownerNode

string

True

Owner node

vmDiskProperties

VmDiskProperties

False

iops

Aggregate IOPS

ProviderVolumeResponse

Name Type Required Description

device

string

True

Device

diskType

string

True

Type

encrypted

boolean

True

Encrypted

id

string

True

Specifies the ID

instance2Id

string

False

Instance2Id

instanceId

string

True

InstanceId

iops

integer

False

Provisioned IOPS

name

string

True

Specifies the name

size

Capacity

True

state

string

True

State

throughput

integer

False

Provisioned throughput

Volume

Name Type Required Description

isClone

boolean

True

Indicates if the volume is a clone volume

name

string

True

Name

rootVolume

boolean

True

Indicates if the volume is the root volume of the SVM

thinProvisioned

boolean

True

Indicates if the volume is thin-provisioned

totalSize

Capacity

True

usedSize

Capacity

True