Retrieve volumes
GET /storage/volumes
Introduced In: 9.6
Retrieves volumes.
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.
-
is_svm_root
-
aggressive_readahead_mode
-
analytics.*
-
anti_ransomware.*
-
application.*
-
encryption.*
-
queue_for_encryption
-
convert_unicode
-
clone.parent_snapshot.name
-
clone.parent_snapshot.uuid
-
clone.parent_svm.name
-
clone.parent_svm.uuid
-
clone.parent_volume.name
-
clone.parent_volume.uuid
-
clone.split_complete_percent
-
clone.split_estimate
-
clone.split_initiated
-
efficiency.*
-
error_state.*
-
files.*
-
max_dir_size
-
nas.export_policy.id
-
nas.gid
-
nas.path
-
nas.security_style
-
nas.uid
-
nas.unix_permissions
-
nas.junction_parent.name
-
nas.junction_parent.uuid
-
snaplock.*
-
restore_to.*
-
snapshot_policy.uuid
-
quota.*
-
qos.*
-
flexcache_endpoint_type
-
space.block_storage_inactive_user_data
-
space.capacity_tier_footprint
-
space.performance_tier_footprint
-
space.local_tier_footprint
-
space.footprint
-
space.over_provisioned
-
space.metadata
-
space.total_footprint
-
space.dedupe_metafiles_footprint
-
space.dedupe_metafiles_temporary_footprint
-
space.delayed_free_footprint
-
space.file_operation_metadata
-
space.snapmirror_destination_footprint
-
space.volume_guarantee_footprint
-
space.cross_volume_dedupe_metafiles_footprint
-
space.cross_volume_dedupe_metafiles_temporary_footprint
-
space.snapshot_reserve_unusable
-
space.snapshot_spill
-
space.user_data
-
space.logical_space.*
-
space.snapshot.*
-
space.used_by_afs
-
space.afs_total
-
space.available_percent
-
space.full_threshold_percent
-
space.nearly_full_threshold_percent
-
space.overwrite_reserve
-
space.overwrite_reserve_used
-
space.size_available_for_snapshots
-
space.percent_used
-
space.fractional_reserve
-
space.block_storage_inactive_user_data_percent
-
space.physical_used
-
space.physical_used_percent
-
space.expected_available
-
space.filesystem_size
-
space.filesystem_size_fixed
-
guarantee.*
-
autosize.*
-
movement.*
-
statistics.*
-
constituents.name
-
constituents.space.size
-
constituents.space.available
-
constituents.space.used
-
constituents.space.available_percent
-
constituents.space.used_percent
-
constituents.space.block_storage_inactive_user_data
-
constituents.space.capacity_tier_footprint
-
constituents.space.performance_tier_footprint
-
constituents.space.local_tier_footprint
-
constituents.space.footprint
-
constituents.space.over_provisioned
-
constituents.space.metadata
-
constituents.space.total_footprint
-
constituents.space.logical_space.reporting
-
constituents.space.logical_space.enforcement
-
constituents.space.logical_space.used_by_afs
-
constituents.space.logical_space.available
-
constituents.space.snapshot.used
-
constituents.space.snapshot.reserve_percent
-
constituents.space.snapshot.autodelete_enabled
-
constituents.space.large_size_enabled
-
constituents.space.max_size
-
constituents.space.total_metadata
-
constituents.space.total_metadata_footprint
-
constituents.aggregates.name
-
constituents.aggregates.uuid
-
constituents.movement.destination_aggregate.name
-
constituents.movement.destination_aggregate.uuid
-
constituents.movement.state
-
constituents.movement.percent_complete
-
constituents.movement.cutover_window
-
constituents.movement.tiering_policy
-
asynchronous_directory_delete.*
-
rebalancing.*
-
metric.*
-
cloud_write_enabled
Related ONTAP commands
-
volume show
-
volume clone show
-
volume efficiency show
-
volume encryption show
-
volume flexcache show
-
volume flexgroup show
-
volume move show
-
volume quota show
-
volume show-space
-
volume snaplock show
-
volume rebalance show
-
security anti-ransomware volume show
-
security anti-ransomware volume space show
-
volume file async-delete client show
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
is_constituent |
boolean |
query |
False |
When set to false, only FlexVol and FlexGroup volumes are returned. When set to true, only FlexGroup constituent volumes are returned. Default for GET calls is false.
|
state |
string |
query |
False |
Filter by state |
rebalancing.max_constituent_imbalance_percent |
integer |
query |
False |
Filter by rebalancing.max_constituent_imbalance_percent
|
rebalancing.runtime |
string |
query |
False |
Filter by rebalancing.runtime
|
rebalancing.start_time |
string |
query |
False |
Filter by rebalancing.start_time
|
rebalancing.stop_time |
string |
query |
False |
Filter by rebalancing.stop_time
|
rebalancing.state |
string |
query |
False |
Filter by rebalancing.state
|
rebalancing.imbalance_size |
integer |
query |
False |
Filter by rebalancing.imbalance_size
|
rebalancing.used_for_imbalance |
integer |
query |
False |
Filter by rebalancing.used_for_imbalance
|
rebalancing.min_threshold |
integer |
query |
False |
Filter by rebalancing.min_threshold
|
rebalancing.exclude_snapshots |
boolean |
query |
False |
Filter by rebalancing.exclude_snapshots
|
rebalancing.notices.code |
string |
query |
False |
Filter by rebalancing.notices.code
|
rebalancing.notices.message |
string |
query |
False |
Filter by rebalancing.notices.message
|
rebalancing.notices.arguments.message |
string |
query |
False |
Filter by rebalancing.notices.arguments.message
|
rebalancing.notices.arguments.code |
string |
query |
False |
Filter by rebalancing.notices.arguments.code
|
rebalancing.engine.movement.most_recent_start_time |
string |
query |
False |
Filter by rebalancing.engine.movement.most_recent_start_time
|
rebalancing.engine.movement.last_error.code |
integer |
query |
False |
Filter by rebalancing.engine.movement.last_error.code
|
rebalancing.engine.movement.last_error.file_id |
integer |
query |
False |
Filter by rebalancing.engine.movement.last_error.file_id
|
rebalancing.engine.movement.last_error.time |
string |
query |
False |
Filter by rebalancing.engine.movement.last_error.time
|
rebalancing.engine.movement.last_error.destination |
integer |
query |
False |
Filter by rebalancing.engine.movement.last_error.destination
|
rebalancing.engine.movement.file_moves_started |
integer |
query |
False |
Filter by rebalancing.engine.movement.file_moves_started
|
rebalancing.engine.scanner.files_skipped.too_large |
integer |
query |
False |
Filter by rebalancing.engine.scanner.files_skipped.too_large
|
rebalancing.engine.scanner.files_skipped.too_small |
integer |
query |
False |
Filter by rebalancing.engine.scanner.files_skipped.too_small
|
rebalancing.engine.scanner.files_skipped.remote_cache |
integer |
query |
False |
Filter by rebalancing.engine.scanner.files_skipped.remote_cache
|
rebalancing.engine.scanner.files_skipped.other |
integer |
query |
False |
Filter by rebalancing.engine.scanner.files_skipped.other
|
rebalancing.engine.scanner.files_skipped.on_demand_destination |
integer |
query |
False |
Filter by rebalancing.engine.scanner.files_skipped.on_demand_destination
|
rebalancing.engine.scanner.files_skipped.write_fenced |
integer |
query |
False |
Filter by rebalancing.engine.scanner.files_skipped.write_fenced
|
rebalancing.engine.scanner.files_skipped.efficiency_percent |
integer |
query |
False |
Filter by rebalancing.engine.scanner.files_skipped.efficiency_percent
|
rebalancing.engine.scanner.files_skipped.incompatible |
integer |
query |
False |
Filter by rebalancing.engine.scanner.files_skipped.incompatible
|
rebalancing.engine.scanner.files_skipped.efficiency_blocks |
integer |
query |
False |
Filter by rebalancing.engine.scanner.files_skipped.efficiency_blocks
|
rebalancing.engine.scanner.files_skipped.footprint_invalid |
integer |
query |
False |
Filter by rebalancing.engine.scanner.files_skipped.footprint_invalid
|
rebalancing.engine.scanner.files_skipped.in_snapshot |
integer |
query |
False |
Filter by rebalancing.engine.scanner.files_skipped.in_snapshot
|
rebalancing.engine.scanner.files_skipped.metadata |
integer |
query |
False |
Filter by rebalancing.engine.scanner.files_skipped.metadata
|
rebalancing.engine.scanner.files_skipped.fast_truncate |
integer |
query |
False |
Filter by rebalancing.engine.scanner.files_skipped.fast_truncate
|
rebalancing.engine.scanner.blocks_scanned |
integer |
query |
False |
Filter by rebalancing.engine.scanner.blocks_scanned
|
rebalancing.engine.scanner.files_scanned |
integer |
query |
False |
Filter by rebalancing.engine.scanner.files_scanned
|
rebalancing.engine.scanner.blocks_skipped.efficiency_percent |
integer |
query |
False |
Filter by rebalancing.engine.scanner.blocks_skipped.efficiency_percent
|
rebalancing.engine.scanner.blocks_skipped.incompatible |
integer |
query |
False |
Filter by rebalancing.engine.scanner.blocks_skipped.incompatible
|
rebalancing.engine.scanner.blocks_skipped.efficiency_blocks |
integer |
query |
False |
Filter by rebalancing.engine.scanner.blocks_skipped.efficiency_blocks
|
rebalancing.engine.scanner.blocks_skipped.footprint_invalid |
integer |
query |
False |
Filter by rebalancing.engine.scanner.blocks_skipped.footprint_invalid
|
rebalancing.engine.scanner.blocks_skipped.in_snapshot |
integer |
query |
False |
Filter by rebalancing.engine.scanner.blocks_skipped.in_snapshot
|
rebalancing.engine.scanner.blocks_skipped.metadata |
integer |
query |
False |
Filter by rebalancing.engine.scanner.blocks_skipped.metadata
|
rebalancing.engine.scanner.blocks_skipped.fast_truncate |
integer |
query |
False |
Filter by rebalancing.engine.scanner.blocks_skipped.fast_truncate
|
rebalancing.engine.scanner.blocks_skipped.too_large |
integer |
query |
False |
Filter by rebalancing.engine.scanner.blocks_skipped.too_large
|
rebalancing.engine.scanner.blocks_skipped.too_small |
integer |
query |
False |
Filter by rebalancing.engine.scanner.blocks_skipped.too_small
|
rebalancing.engine.scanner.blocks_skipped.remote_cache |
integer |
query |
False |
Filter by rebalancing.engine.scanner.blocks_skipped.remote_cache
|
rebalancing.engine.scanner.blocks_skipped.other |
integer |
query |
False |
Filter by rebalancing.engine.scanner.blocks_skipped.other
|
rebalancing.engine.scanner.blocks_skipped.on_demand_destination |
integer |
query |
False |
Filter by rebalancing.engine.scanner.blocks_skipped.on_demand_destination
|
rebalancing.engine.scanner.blocks_skipped.write_fenced |
integer |
query |
False |
Filter by rebalancing.engine.scanner.blocks_skipped.write_fenced
|
rebalancing.target_used |
integer |
query |
False |
Filter by rebalancing.target_used
|
rebalancing.data_moved |
integer |
query |
False |
Filter by rebalancing.data_moved
|
rebalancing.imbalance_percent |
integer |
query |
False |
Filter by rebalancing.imbalance_percent
|
rebalancing.max_threshold |
integer |
query |
False |
Filter by rebalancing.max_threshold
|
rebalancing.min_file_size |
integer |
query |
False |
Filter by rebalancing.min_file_size
|
rebalancing.max_runtime |
string |
query |
False |
Filter by rebalancing.max_runtime
|
rebalancing.max_file_moves |
integer |
query |
False |
Filter by rebalancing.max_file_moves
|
autosize.grow_threshold |
integer |
query |
False |
Filter by autosize.grow_threshold |
autosize.shrink_threshold |
integer |
query |
False |
Filter by autosize.shrink_threshold |
autosize.mode |
string |
query |
False |
Filter by autosize.mode |
autosize.maximum |
integer |
query |
False |
Filter by autosize.maximum |
autosize.minimum |
integer |
query |
False |
Filter by autosize.minimum |
queue_for_encryption |
boolean |
query |
False |
Filter by queue_for_encryption
|
error_state.has_bad_blocks |
boolean |
query |
False |
Filter by error_state.has_bad_blocks |
error_state.is_inconsistent |
boolean |
query |
False |
Filter by error_state.is_inconsistent |
name |
string |
query |
False |
Filter by name
|
snapshot_count |
integer |
query |
False |
Filter by snapshot_count
|
space.available |
integer |
query |
False |
Filter by space.available |
space.physical_used_percent |
integer |
query |
False |
Filter by space.physical_used_percent
|
space.percent_used |
integer |
query |
False |
Filter by space.percent_used
|
space.size_available_for_snapshots |
integer |
query |
False |
Filter by space.size_available_for_snapshots
|
space.filesystem_size_fixed |
boolean |
query |
False |
Filter by space.filesystem_size_fixed
|
space.logical_space.used |
integer |
query |
False |
Filter by space.logical_space.used
|
space.logical_space.used_by_afs |
integer |
query |
False |
Filter by space.logical_space.used_by_afs |
space.logical_space.available |
integer |
query |
False |
Filter by space.logical_space.available |
space.logical_space.used_percent |
integer |
query |
False |
Filter by space.logical_space.used_percent
|
space.logical_space.used_by_snapshots |
integer |
query |
False |
Filter by space.logical_space.used_by_snapshots
|
space.logical_space.enforcement |
boolean |
query |