Retrieve an aggregate specified by the UUID
GET /storage/aggregates/{uuid}
Introduced In: 9.6
Retrieves the aggregate specified by the UUID. The recommend query cannot be used for this operation.
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.*
Related ONTAP commands
-
storage aggregate show
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
uuid |
string |
path |
True |
Aggregate UUID |
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 that are compatible with the aggregate. 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 flash pool creation or addition for the specified aggregate. The default setting is 'false'.
|
auto_provision_policy |
string |
query |
False |
If set to expand, a query is run on the system for the recommended optimal expansion layout of the aggregate.
|
fields |
array[string] |
query |
False |
Specify the fields to return. |
Response
Status: 200, Ok
Name | Type | Description |
---|---|---|
_links |
||
_tags |
array[string] |
Tags are an optional way to track the uses of a resource. Tag values must be formatted as key:value strings. |
block_storage |
Configuration information for the locally attached portion of the aggregate. When a cloud store is also used by this aggregate, this is referred to as the performance tier. |
|
cloud_storage |
Configuration information for the cloud storage portion of the aggregate. This is referred to as the capacity tier. |
|
create_time |
string |
Timestamp of aggregate creation. |
data_encryption |
||
dr_home_node |
Node where the aggregate resides after disaster recovery. The value for this field might differ from the 'node' field during switchover. |
|
home_node |
Node where the aggregate resides after giveback. The value for this field might differ from the value of the 'node' field during takeover. |
|
inactive_data_reporting |
||
inode_attributes |
||
is_spare_low |
boolean |
Specifies whether the aggregate is in a spares low condition on any of the RAID groups. This is an advanced property; there is an added computational cost to retrieving its value. The field is not populated for either a collection GET or an instance GET unless it is explicitly requested using the fields query parameter containing either footprint or **. |
metric |
The most recent sample of I/O metrics for the aggregate. |
|
name |
string |
Aggregate name. |
node |
Node where the aggregate currently resides. |
|
sidl_enabled |
boolean |
Specifies whether or not SIDL is enabled on the aggregate. |
snaplock_type |
string |
SnapLock type. |
snapshot |
||
space |
||
state |
string |
Operational state of the aggregate. |
statistics |
The real time I/O statistics for the aggregate. |
|
uuid |
string |
Aggregate UUID. |
volume-count |
integer |
Number of volumes in the aggregate. |
Example response
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"_tags": [
"team:csi",
"environment:test"
],
"block_storage": {
"hybrid_cache": {
"disk_count": 6,
"disk_type": "string",
"raid_size": 24,
"raid_type": "string",
"simulated_raid_groups": [
{
"name": "string"
}
],
"size": 1612709888,
"storage_pools": [
{
"storage_pool": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "storage_pool_1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}
}
],
"used": 26501122
},
"mirror": {
"enabled": "",
"state": "string"
},
"plexes": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "plex0"
}
],
"primary": {
"checksum_style": "string",
"disk_class": "performance",
"disk_count": 8,
"disk_type": "string",
"raid_size": 16,
"raid_type": "string",
"simulated_raid_groups": [
{
"name": "string",
"raid_type": "string"
}
]
},
"storage_type": "string"
},
"cloud_storage": {
"max_cloud_cache_percent": 10,
"stores": [
{
"cloud_store": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "store1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"used": 0
}
]
},
"create_time": "2018-01-01 11:00:00 -0500",
"dr_home_node": {
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"home_node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"inactive_data_reporting": {
"start_time": "2019-12-12 11:00:00 -0500"
},
"inode_attributes": {
"file_private_capacity": 31136,
"file_public_capacity": 31136,
"files_private_used": 502,
"files_total": 31136,
"files_used": 97,
"max_files_available": 31136,
"max_files_possible": 2844525,
"max_files_used": 97,
"used_percent": 5,
"version": 4
},
"is_spare_low": "",
"metric": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"duration": "PT15S",
"iops": {
"read": 200,
"total": 1000,
"write": 100
},
"latency": {
"read": 200,
"total": 1000,
"write": 100
},
"status": "ok",
"throughput": {
"read": 200,
"total": 1000,
"write": 100
},
"timestamp": "2017-01-25 06:20:13 -0500"
},
"name": "node1_aggr_1",
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"snaplock_type": "string",
"snapshot": {
"files_total": 10,
"files_used": 3,
"max_files_available": 5,
"max_files_used": 50
},
"space": {
"block_storage": {
"aggregate_metadata": 2655,
"aggregate_metadata_percent": 8,
"available": 10156560384,
"data_compacted_count": 1990000,
"data_compaction_space_saved": 1996000,
"data_compaction_space_saved_percent": 27,
"full_threshold_percent": 0,
"inactive_user_data": 304448,
"inactive_user_data_percent": 0,
"performance_tier_cache_used": 22348,
"physical_used": 2461696,
"physical_used_percent": 50,
"size": 10156769280,
"used": 2088960,
"used_including_snapshot_reserve": 674685,
"used_including_snapshot_reserve_percent": 35,
"used_percent": 50,
"volume_deduplication_shared_count": 1990000,
"volume_deduplication_space_saved": 1996000,
"volume_deduplication_space_saved_percent": 27,
"volume_footprints_percent": 14
},
"cloud_storage": {
"used": 402743264
},
"efficiency": {
"logical_used": 0,
"ratio": 0,
"savings": 0,
"wise_tsse_min_used_capacity_pct": 0
},
"efficiency_without_snapshots": {
"logical_used": 0,
"ratio": 0,
"savings": 0
},
"efficiency_without_snapshots_flexclones": {
"logical_used": 0,
"ratio": 0,
"savings": 0
},
"footprint": 608896,
"snapshot": {
"available": 2000,
"reserve_percent": 20,
"total": 5000,
"used": 3000,
"used_percent": 45
}
},
"state": "string",
"statistics": {
"iops_raw": {
"read": 200,
"total": 1000,
"write": 100
},
"latency_raw": {
"read": 200,
"total": 1000,
"write": 100
},
"status": "ok",
"throughput_raw": {
"read": 200,
"total": 1000,
"write": 100
},
"timestamp": "2017-01-25 06:20:13 -0500"
},
"uuid": "string",
"volume-count": 0
}
Error
Status: Default
ONTAP Error Response Codes
Error Code | Description |
---|---|
787092 |
The target field cannot be specified for this operation. |
7209049 |
Cannot perform the operation because the aggregate is currently expanding. |
8586225 |
Unexpected error encountered when retrieving metrics and statistics for this aggregate. |
19726382 |
Another provisioning operation is in progress on this cluster. Wait a few minutes, and try the operation again. |
19726390 |
Unable to provide a recommmendation to expand the aggregate. |
19726391 |
Too many unassigned disks visible to the node that owns this aggregate. |
19726392 |
Layout of this aggregate is not a supported configuration. |
19726393 |
Failed to expand the aggregate. Aggregate expansion is not supported on this system. |
19726394 |
Automatic aggregate expansion is not supported on systems with multiple data aggregates. |
19726395 |
Automatic aggregate expansion is not supported when MetroCluster is not configured |
19726396 |
Automatic aggregate expansion is not supported when the DR group is not in a normal state |
19726397 |
Aggregates must contain disks with identical disk-types and disk-sizes. |
19726402 |
Internal error. Unable to determine the MetroCluster configuration state. |
19726538 |
Cannot perform the operation because the aggregate is not in a healthy state. |
19726541 |
Cannot perform the operation because the specified aggregate is a root aggregate. |
Also see the table of common errors in the Response body overview section of this documentation.
Name | Type | Description |
---|---|---|
error |
Example error
{
"error": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist",
"target": "uuid"
}
}
Definitions
See Definitions
href
Name | Type | Description |
---|---|---|
href |
string |
_links
Name | Type | Description |
---|---|---|
self |
simulated_raid_groups
Name | Type | Description |
---|---|---|
added_data_disk_count |
integer |
Number of added data disks in RAID group. |
added_parity_disk_count |
integer |
Number of added parity disks in RAID group. |
existing_data_disk_count |
integer |
Number of existing data disks in the RAID group. |
existing_parity_disk_count |
integer |
Number of existing parity disks in the RAID group. |
is_partition |
boolean |
Indicates whether the disk is partitioned (true) or whole (false). |
name |
string |
Name of the raid group. |
usable_size |
integer |
Usable size of each disk, in bytes. |
storage_pool_reference
Shared Storage Pool
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
|
uuid |
string |
storage_pools
Name | Type | Description |
---|---|---|
allocation_units_count |
integer |
Allocation count of storage pool. |
storage_pool |
Shared Storage Pool |
hybrid_cache
Contains the configuration for the hybrid cache. The hybrid cache is made up of either whole SSDs or storage pool SSDs.
Name | Type | Description |
---|---|---|
disk_count |
integer |
Number of disks used in the cache tier of the aggregate. Only provided when hybrid_cache.enabled is 'true'. |
disk_type |
string |
Type of disk being used by the aggregate's cache tier. |
enabled |
boolean |
Specifies whether the aggregate uses HDDs with SSDs as a cache. |
raid_size |
integer |
Option to specify the maximum number of disks that can be included in a RAID group. |
raid_type |
string |
RAID type for SSD cache of the aggregate. Only provided when hybrid_cache.enabled is 'true'. |
simulated_raid_groups |
array[simulated_raid_groups] |
|
size |
integer |
Total usable space in bytes of SSD cache. Only provided when hybrid_cache.enabled is 'true'. |
storage_pools |
array[storage_pools] |
List of storage pool properties and allocation_units_count for aggregate. |
used |
integer |
Space used in bytes of SSD cache. Only provided when hybrid_cache.enabled is 'true'. |
mirror
Name | Type | Description |
---|---|---|
enabled |
boolean |
Aggregate is SyncMirror protected |
state |
string |
plex_reference
Plex
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
simulated_raid_groups
Name | Type | Description |
---|---|---|
added_data_disk_count |
integer |
Number of added data disks in RAID group. |
added_parity_disk_count |
integer |
Number of added parity disks in RAID group. |
data_disk_count |
integer |
Number of data disks in RAID group. |
existing_data_disk_count |
integer |
Number of existing data disks in the RAID group. |
existing_parity_disk_count |
integer |
Number of existing parity disks in the RAID group. |
is_partition |
boolean |
Indicates whether the disk is partitioned (true) or whole (false). |
name |
string |
Name of the raid group. |
parity_disk_count |
integer |
Number of parity disks in RAID group. |
raid_type |
string |
RAID type of the aggregate. |
usable_size |
integer |
Usable size of each disk, in bytes. |
primary
Configuration information for the primary storage portion of the aggregate. This excludes the hybrid cache details.
Name | Type | Description |
---|---|---|
checksum_style |
string |
The checksum style used by the aggregate. |
disk_class |
string |
The class of disks being used by the aggregate. |
disk_count |
integer |
Number of disks used in the aggregate. This includes parity disks, but excludes disks in the hybrid cache. |
disk_type |
string |
The type of disk being used by the aggregate. |
raid_size |
integer |
Option to specify the maximum number of disks that can be included in a RAID group. |
raid_type |
string |
RAID type of the aggregate. |
simulated_raid_groups |
array[simulated_raid_groups] |
block_storage
Configuration information for the locally attached portion of the aggregate. When a cloud store is also used by this aggregate, this is referred to as the performance tier.
Name | Type | Description |
---|---|---|
hybrid_cache |
Contains the configuration for the hybrid cache. The hybrid cache is made up of either whole SSDs or storage pool SSDs. |
|
mirror |
||
plexes |
array[plex_reference] |
Plex reference for each plex in the aggregate. |
primary |
Configuration information for the primary storage portion of the aggregate. This excludes the hybrid cache details. |
|
storage_type |
string |
Type of aggregate. |
uses_partitions |
boolean |
If true, aggregate is using shared disks. |
cloud_store
Cloud store