Skip to main content

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.timestamp

string

query

False

Filter by statistics.timestamp

  • Introduced in: 9.7

statistics.iops_raw.write

integer

query

False

Filter by statistics.iops_raw.write

  • 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.total

integer

query

False

Filter by statistics.iops_raw.total

  • Introduced in: 9.7

statistics.status

string

query

False

Filter by statistics.status

  • Introduced in: 9.7

statistics.throughput_raw.write

integer

query

False

Filter by statistics.throughput_raw.write

  • 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.total

integer

query

False

Filter by statistics.throughput_raw.total

  • Introduced in: 9.7

statistics.latency_raw.write

integer

query

False

Filter by statistics.latency_raw.write

  • Introduced in: 9.7

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.total

integer

query

False

Filter by statistics.latency_raw.total

  • Introduced in: 9.7

create_time

string

query

False

Filter by create_time

cloud_storage.attach_eligible

boolean

query

False

Filter by cloud_storage.attach_eligible

  • Introduced in: 9.14

cloud_storage.stores.used

integer

query

False

Filter by cloud_storage.stores.used

  • Introduced in: 9.14

cloud_storage.stores.cloud_store.uuid

string

query

False

Filter by cloud_storage.stores.cloud_store.uuid

  • Introduced in: 9.14

cloud_storage.stores.cloud_store.name

string

query

False

Filter by cloud_storage.stores.cloud_store.name

  • Introduced in: 9.14

sidl_enabled

boolean

query

False

Filter by sidl_enabled

  • Introduced in: 9.11

uuid

string

query

False

Filter by uuid

snapshot.max_files_available

integer

query

False

Filter by snapshot.max_files_available

  • Introduced in: 9.10

snapshot.files_total

integer

query

False

Filter by snapshot.files_total

  • Introduced in: 9.10

snapshot.files_used

integer

query

False

Filter by snapshot.files_used

  • Introduced in: 9.10

snapshot.max_files_used

integer

query

False

Filter by snapshot.max_files_used

  • Introduced in: 9.10

home_node.uuid

string

query

False

Filter by home_node.uuid

home_node.name

string

query

False

Filter by home_node.name

_tags

string

query

False

Filter by _tags

  • Introduced in: 9.13

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.plexes.name

string

query

False

Filter by block_storage.plexes.name

block_storage.storage_type

string

query

False

Filter by block_storage.storage_type

  • Introduced in: 9.11

block_storage.uses_partitions

boolean

query

False

Filter by block_storage.uses_partitions

  • Introduced in: 9.11

block_storage.hybrid_cache.raid_type

string

query

False

Filter by block_storage.hybrid_cache.raid_type

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_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.is_partition

boolean

query

False

Filter by block_storage.hybrid_cache.simulated_raid_groups.is_partition

  • 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.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.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.size

integer

query

False

Filter by block_storage.hybrid_cache.size

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.used

integer

query

False

Filter by block_storage.hybrid_cache.used

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.enabled

boolean

query

False

Filter by block_storage.hybrid_cache.enabled

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.primary.disk_class

string

query

False

Filter by block_storage.primary.disk_class

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.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.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.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.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.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.name

string

query

False

Filter by block_storage.primary.simulated_raid_groups.name

  • Introduced in: 9.10

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.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.parity_disk_count

integer

query

False

Filter by block_storage.primary.simulated_raid_groups.parity_disk_count

  • Introduced in: 9.10

block_storage.primary.raid_size

integer

query

False

Filter by block_storage.primary.raid_size

block_storage.primary.raid_type

string

query

False

Filter by block_storage.primary.raid_type

block_storage.primary.disk_type

string

query

False

Filter by block_storage.primary.disk_type

  • Introduced in: 9.7

block_storage.primary.disk_count

integer

query

False

Filter by block_storage.primary.disk_count

block_storage.primary.checksum_style

string

query

False

Filter by block_storage.primary.checksum_style

state

string

query

False

Filter by state

data_encryption.software_encryption_enabled

boolean

query

False

Filter by data_encryption.software_encryption_enabled

data_encryption.drive_protection_enabled

boolean

query

False

Filter by data_encryption.drive_protection_enabled

dr_home_node.uuid

string

query

False

Filter by dr_home_node.uuid

dr_home_node.name

string

query

False

Filter by dr_home_node.name

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

inode_attributes.files_private_used

integer

query

False

Filter by inode_attributes.files_private_used

  • Introduced in: 9.11

inode_attributes.version

integer

query

False

Filter by inode_attributes.version

  • Introduced in: 9.11

inode_attributes.max_files_available

integer

query

False

Filter by inode_attributes.max_files_available

  • Introduced in: 9.11

inode_attributes.file_public_capacity

integer

query

False

Filter by inode_attributes.file_public_capacity

  • Introduced in: 9.11

inode_attributes.max_files_possible

integer

query

False

Filter by inode_attributes.max_files_possible

  • Introduced in: 9.11

inode_attributes.files_total