Skip to main content
A newer release of this product is available.

Retrieve a collection of aggregates for an entire cluster

Contributors
PDFs

GET /storage/aggregates

Introduced In: 9.6

Retrieves the collection of aggregates for the entire cluster.

Expensive properties

There is an added computational cost to retrieving values for these properties. They are not included by default in GET results and must be explicitly requested using the fields query parameter. See Requesting specific fields to learn more.

  • metric.*

  • space.block_storage.inactive_user_data

  • space.block_storage.inactive_user_data_percent

  • space.footprint

  • is_spare_low

  • statistics.*

  • storage aggregate show

Parameters

Name Type In Required Description

recommend

boolean

query

False

If set to 'true', it queries the system for the recommended optimal layout for creating new aggregates. The default setting is 'false'.

show_spares

boolean

query

False

If set to 'true', the spares object is returned instead of records to show the spare groups in the cluster. The default setting is 'false'.

flash_pool_eligible

boolean

query

False

If set to 'true' along with show_spares, the spares object is restricted to return spare groups that are compatible with whole disk based flash pool creation. The default setting is 'false'.

  • Introduced in: 9.12

statistics.latency_raw.read

integer

query

False

Filter by statistics.latency_raw.read

  • Introduced in: 9.7

statistics.latency_raw.other

integer

query

False

Filter by statistics.latency_raw.other

  • Introduced in: 9.7

statistics.latency_raw.write

integer

query

False

Filter by statistics.latency_raw.write

  • Introduced in: 9.7

statistics.latency_raw.total

integer

query

False

Filter by statistics.latency_raw.total

  • Introduced in: 9.7

statistics.iops_raw.read

integer

query

False

Filter by statistics.iops_raw.read

  • Introduced in: 9.7

statistics.iops_raw.other

integer

query

False

Filter by statistics.iops_raw.other

  • Introduced in: 9.7

statistics.iops_raw.write

integer

query

False

Filter by statistics.iops_raw.write

  • Introduced in: 9.7

statistics.iops_raw.total

integer

query

False

Filter by statistics.iops_raw.total

  • Introduced in: 9.7

statistics.timestamp

string

query

False

Filter by statistics.timestamp

  • Introduced in: 9.7

statistics.status

string

query

False

Filter by statistics.status

  • Introduced in: 9.7

statistics.throughput_raw.read

integer

query

False

Filter by statistics.throughput_raw.read

  • Introduced in: 9.7

statistics.throughput_raw.other

integer

query

False

Filter by statistics.throughput_raw.other

  • Introduced in: 9.7

statistics.throughput_raw.write

integer

query

False

Filter by statistics.throughput_raw.write

  • Introduced in: 9.7

statistics.throughput_raw.total

integer

query

False

Filter by statistics.throughput_raw.total

  • Introduced in: 9.7

data_encryption.drive_protection_enabled

boolean

query

False

Filter by data_encryption.drive_protection_enabled

data_encryption.software_encryption_enabled

boolean

query

False

Filter by data_encryption.software_encryption_enabled

sidl_enabled

boolean

query

False

Filter by sidl_enabled

  • Introduced in: 9.11

inactive_data_reporting.enabled

boolean

query

False

Filter by inactive_data_reporting.enabled

  • Introduced in: 9.8

inactive_data_reporting.start_time

string

query

False

Filter by inactive_data_reporting.start_time

  • Introduced in: 9.8

block_storage.storage_type

string

query

False

Filter by block_storage.storage_type

  • Introduced in: 9.11

block_storage.plexes.name

string

query

False

Filter by block_storage.plexes.name

block_storage.hybrid_cache.raid_size

integer

query

False

Filter by block_storage.hybrid_cache.raid_size

  • Introduced in: 9.12

block_storage.hybrid_cache.raid_type

string

query

False

Filter by block_storage.hybrid_cache.raid_type

block_storage.hybrid_cache.simulated_raid_groups.added_parity_disk_count

integer

query

False

Filter by block_storage.hybrid_cache.simulated_raid_groups.added_parity_disk_count

  • Introduced in: 9.12

block_storage.hybrid_cache.simulated_raid_groups.name

string

query

False

Filter by block_storage.hybrid_cache.simulated_raid_groups.name

  • Introduced in: 9.12

block_storage.hybrid_cache.simulated_raid_groups.existing_data_disk_count

integer

query

False

Filter by block_storage.hybrid_cache.simulated_raid_groups.existing_data_disk_count

  • Introduced in: 9.12

block_storage.hybrid_cache.simulated_raid_groups.usable_size

integer

query

False

Filter by block_storage.hybrid_cache.simulated_raid_groups.usable_size

  • Introduced in: 9.12

block_storage.hybrid_cache.simulated_raid_groups.existing_parity_disk_count

integer

query

False

Filter by block_storage.hybrid_cache.simulated_raid_groups.existing_parity_disk_count

  • Introduced in: 9.12

block_storage.hybrid_cache.simulated_raid_groups.added_data_disk_count

integer

query

False

Filter by block_storage.hybrid_cache.simulated_raid_groups.added_data_disk_count

  • Introduced in: 9.12

block_storage.hybrid_cache.simulated_raid_groups.is_partition

boolean

query

False

Filter by block_storage.hybrid_cache.simulated_raid_groups.is_partition

  • Introduced in: 9.12

block_storage.hybrid_cache.enabled

boolean

query

False

Filter by block_storage.hybrid_cache.enabled

block_storage.hybrid_cache.size

integer

query

False

Filter by block_storage.hybrid_cache.size

block_storage.hybrid_cache.storage_pools.storage_pool.uuid

string

query

False

Filter by block_storage.hybrid_cache.storage_pools.storage_pool.uuid

  • Introduced in: 9.11

block_storage.hybrid_cache.storage_pools.storage_pool.name

string

query

False

Filter by block_storage.hybrid_cache.storage_pools.storage_pool.name

  • Introduced in: 9.11

block_storage.hybrid_cache.storage_pools.allocation_units_count

integer

query

False

Filter by block_storage.hybrid_cache.storage_pools.allocation_units_count

  • Introduced in: 9.11

block_storage.hybrid_cache.used

integer

query

False

Filter by block_storage.hybrid_cache.used

block_storage.hybrid_cache.disk_count

integer

query

False

Filter by block_storage.hybrid_cache.disk_count

block_storage.hybrid_cache.disk_type

string

query

False

Filter by block_storage.hybrid_cache.disk_type

  • Introduced in: 9.12

block_storage.mirror.state

string

query

False

Filter by block_storage.mirror.state

block_storage.mirror.enabled

boolean

query

False

Filter by block_storage.mirror.enabled

block_storage.primary.disk_type

string

query

False

Filter by block_storage.primary.disk_type

  • Introduced in: 9.7

block_storage.primary.disk_class

string

query

False

Filter by block_storage.primary.disk_class

block_storage.primary.disk_count

integer

query

False

Filter by block_storage.primary.disk_count

block_storage.primary.simulated_raid_groups.added_data_disk_count

integer

query

False

Filter by block_storage.primary.simulated_raid_groups.added_data_disk_count

  • Introduced in: 9.11

block_storage.primary.simulated_raid_groups.is_partition

boolean

query

False

Filter by block_storage.primary.simulated_raid_groups.is_partition

  • Introduced in: 9.10

block_storage.primary.simulated_raid_groups.existing_parity_disk_count

integer

query

False

Filter by block_storage.primary.simulated_raid_groups.existing_parity_disk_count

  • Introduced in: 9.11

block_storage.primary.simulated_raid_groups.existing_data_disk_count

integer

query

False

Filter by block_storage.primary.simulated_raid_groups.existing_data_disk_count

  • Introduced in: 9.11

block_storage.primary.simulated_raid_groups.data_disk_count

integer

query

False

Filter by block_storage.primary.simulated_raid_groups.data_disk_count

  • Introduced in: 9.10

block_storage.primary.simulated_raid_groups.added_parity_disk_count

integer

query

False

Filter by block_storage.primary.simulated_raid_groups.added_parity_disk_count

  • Introduced in: 9.11

block_storage.primary.simulated_raid_groups.parity_disk_count

integer

query

False

Filter by block_storage.primary.simulated_raid_groups.parity_disk_count

  • Introduced in: 9.10

block_storage.primary.simulated_raid_groups.usable_size

integer

query

False

Filter by block_storage.primary.simulated_raid_groups.usable_size

  • Introduced in: 9.10

block_storage.primary.simulated_raid_groups.name

string

query

False

Filter by block_storage.primary.simulated_raid_groups.name

  • Introduced in: 9.10

block_storage.primary.simulated_raid_groups.raid_type

string

query

False

Filter by block_storage.primary.simulated_raid_groups.raid_type

  • Introduced in: 9.10

block_storage.primary.raid_type

string

query

False

Filter by block_storage.primary.raid_type

block_storage.primary.raid_size

integer

query

False

Filter by block_storage.primary.raid_size

block_storage.primary.checksum_style

string

query

False

Filter by block_storage.primary.checksum_style

block_storage.uses_partitions

boolean

query

False

Filter by block_storage.uses_partitions

  • Introduced in: 9.11

volume-count

integer

query

False

Filter by volume-count

  • Introduced in: 9.11

_tags

string

query

False

Filter by _tags

  • Introduced in: 9.13

metric.timestamp

string

query

False

Filter by metric.timestamp

  • Introduced in: 9.7

metric.status

string

query

False

Filter by metric.status

  • Introduced in: 9.7

metric.throughput.read

integer

query

False

Filter by metric.throughput.read

  • Introduced in: 9.7

metric.throughput.other

integer

query

False

Filter by metric.throughput.other

  • Introduced in: 9.7

metric.throughput.write

integer

query

False

Filter by metric.throughput.write

  • Introduced in: 9.7

metric.throughput.total

integer

query

False

Filter by metric.throughput.total

  • Introduced in: 9.7

metric.duration

string

query

False

Filter by metric.duration

  • Introduced in: 9.7

metric.latency.read

integer

query

False

Filter by metric.latency.read

  • Introduced in: 9.7

metric.latency.other

integer

query

False

Filter by metric.latency.other

  • Introduced in: 9.7

metric.latency.write

integer

query

False

Filter by metric.latency.write

  • Introduced in: 9.7

metric.latency.total

integer

query

False

Filter by metric.latency.total

  • Introduced in: 9.7

metric.iops.read

integer

query

False

Filter by metric.iops.read

  • Introduced in: 9.7

metric.iops.other

integer

query

False

Filter by metric.iops.other

  • Introduced in: 9.7

metric.iops.write

integer

query

False

Filter by metric.iops.write

  • Introduced in: 9.7

metric.iops.total

integer

query

False

Filter by metric.iops.total

  • Introduced in: 9.7

home_node.uuid

string

query

False

Filter by home_node.uuid

home_node.name

string

query

False

Filter by home_node.name

dr_home_node.name

string

query

False

Filter by dr_home_node.name

dr_home_node.uuid

string

query

False

Filter by dr_home_node.uuid

recommendation_spares.is_partition

boolean

query

False

Filter by recommendation_spares.is_partition

  • Introduced in: 9.10

recommendation_spares.disk_class

string

query

False

Filter by recommendation_spares.disk_class

  • Introduced in: 9.10

recommendation_spares.disk_type

string

query

False

Filter by recommendation_spares.disk_type

  • Introduced in: 9.10

recommendation_spares.checksum_style

string

query

False

Filter by recommendation_spares.checksum_style

  • Introduced in: 9.10

recommendation_spares.syncmirror_pool

string

query

False

Filter by recommendation_spares.syncmirror_pool

  • Introduced in: 9.10

recommendation_spares.size

integer

query

False

Filter by recommendation_spares.size

  • Introduced in: 9.10

recommendation_spares.usable

integer

query

False

Filter by recommendation_spares.usable

  • Introduced in: 9.10

recommendation_spares.node.uuid

string

query

False

Filter by recommendation_spares.node.uuid

  • Introduced in: 9.10

recommendation_spares.node.name

string

query

False

Filter by recommendation_spares.node.name

  • Introduced in: 9.10

recommendation_spares.layout_requirements.raid_type

string

query

False

Filter by recommendation_spares.layout_requirements.raid_type

  • Introduced in: 9.10

recommendation_spares.layout_requirements.default

boolean

query

False

Filter by recommendation_spares.layout_requirements.default

  • Introduced in: 9.10

recommendation_spares.layout_requirements.raid_group.max

integer

query

False

Filter by recommendation_spares.layout_requirements.raid_group.max

  • Introduced in: 9.10

recommendation_spares.layout_requirements.raid_group.default

integer

query

False

Filter by recommendation_spares.layout_requirements.raid_group.default

  • Introduced in: 9.10

recommendation_spares.layout_requirements.raid_group.min

integer

query

False

Filter by recommendation_spares.layout_requirements.raid_group.min

  • Introduced in: 9.10

recommendation_spares.layout_requirements.aggregate_min_disks

integer

query

False

Filter by recommendation_spares.layout_requirements.aggregate_min_disks

  • Introduced in: 9.10

recommendation_spares.total

integer

query

False

Filter by recommendation_spares.total

  • Introduced in: 9.11

space.cloud_storage.used

integer

query

False

Filter by space.cloud_storage.used

space.footprint

integer

query

False

Filter by space.footprint

space.efficiency.logical_used

integer

query

False

Filter by space.efficiency.logical_used

space.efficiency.cross_volume_inline_dedupe

boolean

query

False

Filter by space.efficiency.cross_volume_inline_dedupe

  • Introduced in: 9.12

space.efficiency.cross_volume_background_dedupe

boolean

query

False

Filter by space.efficiency.cross_volume_background_dedupe

  • Introduced in: 9.12

space.efficiency.ratio

number

query

False

Filter by space.efficiency.ratio

space.efficiency.savings

integer

query

False

Filter by space.efficiency.savings

space.efficiency.cross_volume_dedupe_savings

boolean

query

False

Filter by space.efficiency.cross_volume_dedupe_savings

  • Introduced in: 9.12

space.efficiency.auto_adaptive_compression_savings

boolean

query

False

Filter by space.efficiency.auto_adaptive_compression_savings

  • Introduced in: 9.12

space.efficiency_without_snapshots_flexclones.logical_used

integer

query

False

Filter by space.efficiency_without_snapshots_flexclones.logical_used

  • Introduced in: 9.9

space.efficiency_without_snapshots_flexclones.savings

integer

query

False

Filter by space.efficiency_without_snapshots_flexclones.savings

  • Introduced in: 9.9

space.efficiency_without_snapshots_flexclones.ratio

number

query

False

Filter by space.efficiency_without_snapshots_flexclones.ratio

  • Introduced in: 9.9

space.block_storage.available

integer

query

False

Filter by space.block_storage.available

space.block_storage.size

integer

query

False

Filter by space.block_storage.size

space.block_storage.full_threshold_percent

integer

query

False

Filter by space.block_storage.full_threshold_percent

space.block_storage.volume_deduplication_space_saved

integer

query

False

Filter by space.block_storage.volume_deduplication_space_saved

  • Introduced in: 9.10

space.block_storage.volume_deduplication_space_saved_percent

integer

query

False

Filter by space.block_storage.volume_deduplication_space_saved_percent

  • Introduced in: 9.10

space.block_storage.data_compaction_space_saved

integer

query

False

Filter by space.block_storage.data_compaction_space_saved

  • Introduced in: 9.10

space.block_storage.data_compaction_space_saved_percent

integer

query

False

Filter by space.block_storage.data_compaction_space_saved_percent

  • Introduced in: 9.10

space.block_storage.data_compacted_count

integer

query

False

Filter by space.block_storage.data_compacted_count

  • Introduced in: 9.10

space.block_storage.used_including_snapshot_reserve_percent

integer

query

False

Filter by space.block_storage.used_including_snapshot_reserve_percent

  • Introduced in: 9.10

space.block_storage.used_including_snapshot_reserve

integer

query

False

Filter by space.block_storage.used_including_snapshot_reserve

  • Introduced in: 9.10

space.block_storage.inactive_user_data_percent

integer

query

False

Filter by space.block_storage.inactive_user_data_percent

  • Introduced in: 9.10

space.block_storage.inactive_user_data

integer

query

False

Filter by space.block_storage.inactive_user_data

space.block_storage.volume_footprints_percent

integer

query

False

Filter by space.block_storage.volume_footprints_percent

  • Introduced in: 9.10

space.block_storage.used

integer

query

False

Filter by space.block_storage.used

space.block_storage.physical_used_percent

integer

query

False

Filter by space.block_storage.physical_used_percent

  • Introduced in: 9.10

space.block_storage.aggregate_metadata

integer

query

False

Filter by space.block_storage.aggregate_metadata

  • Introduced in: 9.10

space.block_storage.aggregate_metadata_percent

integer

query

False

Filter by space.block_storage.aggregate_metadata_percent

  • Introduced in: 9.10

space.block_storage.volume_deduplication_shared_count

integer

query

False

Filter by space.block_storage.volume_deduplication_shared_count

  • Introduced in: 9.10

space.block_storage.used_percent

integer

query

False

Filter by space.block_storage.used_percent

  • Introduced in: 9.13

space.block_storage.physical_used

integer

query

False

Filter by space.block_storage.physical_used

  • Introduced in: 9.9

space.snapshot.reserve_percent

integer

query

False

Filter by space.snapshot.reserve_percent

  • Introduced in: 9.10

space.snapshot.used_percent

integer

query

False

Filter by space.snapshot.used_percent

  • Introduced in: 9.10

space.snapshot.total

integer

query

False

Filter by space.snapshot.total

  • Introduced in: 9.10

space.snapshot.available

integer

query

False

Filter by space.snapshot.available

  • Introduced in: 9.10

space.snapshot.used

integer

query

False

Filter by space.snapshot.used

  • Introduced in: 9.10

space.efficiency_without_snapshots.logical_used

integer

query

False

Filter by space.efficiency_without_snapshots.logical_used

space.efficiency_without_snapshots.savings

integer

query

False

Filter by space.efficiency_without_snapshots.savings

space.efficiency_without_snapshots.ratio

number

query

False

Filter by space.efficiency_without_snapshots.ratio

node.uuid

string

query

False

Filter by no