REST API reference
Retrieve an aggregate specified by the UUID
Suggest changes
PDFs
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": {
"stores": [
{
"cloud_store": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "store1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"used": 0
}
]
},
"create_time": "2018-01-01 16:00:00 +0000",
"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 16:00:00 +0000"
},
"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 11:20:13 +0000"
},
"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,
"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 11:20:13 +0000"
},
"uuid": "string",
"volume-count": 0
}Error
Status: DefaultONTAP 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
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
uuid |
string |
cloud_storage_tier
| Name | Type | Description |
|---|---|---|
cloud_store |
Cloud store |
|
used |
integer |
Capacity used in bytes in the cloud store by this aggregate. This is a cached value calculated every 5 minutes. |
cloud_storage
Configuration information for the cloud storage portion of the aggregate. This is referred to as the capacity tier.
| Name | Type | Description |
|---|---|---|
attach_eligible |
boolean |
Specifies whether the aggregate is eligible for a cloud store to be attached. |
migrate_threshold |
integer |
Specifies the minimum percentage of performance tier free space that must exist in order for migration of data from the capacity tier to performance tier to be allowed. Only valid for PATCH operations. |
stores |
array[cloud_storage_tier] |
Configuration information for each cloud storage portion of the aggregate. |
tiering_fullness_threshold |
integer |
The percentage of space in the performance tier that must be used before data is tiered out to the cloud store. Only valid for PATCH operations. |
data_encryption
| Name | Type | Description |
|---|---|---|
drive_protection_enabled |
boolean |
Specifies whether the aggregate uses self-encrypting drives with data protection enabled. |
software_encryption_enabled |
boolean |
Specifies whether NetApp aggregate encryption is enabled. All data in the aggregate is encrypted. |
dr_home_node
Node where the aggregate resides after disaster recovery. The value for this field might differ from the 'node' field during switchover.
| Name | Type | Description |
|---|---|---|
name |
string |
|
uuid |
string |
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.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
uuid |
string |
inactive_data_reporting
| Name | Type | Description |
|---|---|---|
enabled |
boolean |
Specifes whether or not inactive data reporting is enabled on the aggregate. |
start_time |
string |
Timestamp at which inactive data reporting was enabled on the aggregate. |
inode_attributes
| Name | Type | Description |
|---|---|---|
file_private_capacity |
integer |
Number of files that can currently be stored on disk for system metadata files. This number will dynamically increase as more system files are created. This is an advanced property; there is an added computationl 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 **. |
file_public_capacity |
integer |
Number of files that can currently be stored on disk for user-visible files. This number will dynamically increase as more user-visible files are created. 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 **. |
files_private_used |
integer |
Number of system metadata files used. If the referenced file system is restricted or offline, a value of 0 is returned. 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 **. |
files_total |
integer |
Maximum number of user-visible files that this referenced file system can currently hold. If the referenced file system is restricted or offline, a value of 0 is returned. |
files_used |
integer |
Number of user-visible files used in the referenced file system. If the referenced file system is restricted or offline, a value of 0 is returned. |
max_files_available |
integer |
The count of the maximum number of user-visible files currently allowable on the referenced file system. |
max_files_possible |
integer |
The largest value to which the maxfiles-available parameter can be increased by reconfiguration, on the referenced file system. |
max_files_used |
integer |
The number of user-visible files currently in use on the referenced file system. |
used_percent |
integer |
The percentage of disk space currently in use based on user-visible file count on the referenced file system. |
version |
integer |
The inofile-version of the aggregate. If the referenced file system is restricted or offline, a value of 0 is returned. 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 **. |
iops
The rate of I/O operations observed at the storage object.
| Name | Type | Description |
|---|---|---|
other |
integer |
Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on. |
read |
integer |
Performance metric for read I/O operations. |
total |
integer |
Performance metric aggregated over all types of I/O operations. |
write |
integer |
Peformance metric for write I/O operations. |
latency
The round trip latency in microseconds observed at the storage object.
| Name | Type | Description |
|---|---|---|
other |
integer |
Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on. |
read |
integer |
Performance metric for read I/O operations. |
total |
integer |
Performance metric aggregated over all types of I/O operations. |
write |
integer |
Peformance metric for write I/O operations. |
throughput
The rate of throughput bytes per second observed at the storage object.
| Name | Type | Description |
|---|---|---|
other |
integer |
Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on. |
read |
integer |
Performance metric for read I/O operations. |
total |
integer |
Performance metric aggregated over all types of I/O operations. |
write |
integer |
Peformance metric for write I/O operations. |
metric
The most recent sample of I/O metrics for the aggregate.
| Name | Type | Description |
|---|---|---|
_links |
||
duration |
string |
The duration over which this sample is calculated. The time durations are represented in the ISO-8601 standard format. Samples can be calculated over the following durations: |
iops |
The rate of I/O operations observed at the storage object. |
|
latency |
The round trip latency in microseconds observed at the storage object. |
|
status |
string |
Errors associated with the sample. For example, if the aggregation of data over multiple nodes fails, then any partial errors might return "ok" on success or "error" on an internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "Inconsistent_ delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "Inconsistent_old_data" is returned when one or more nodes do not have the latest data. |
throughput |
The rate of throughput bytes per second observed at the storage object. |
|
timestamp |
string |
The timestamp of the performance data. |
node
Node where the aggregate currently resides.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
uuid |
string |
snapshot
| Name | Type | Description |
|---|---|---|
files_total |
integer |
Total files allowed in Snapshot copies |
files_used |
integer |
Total files created in Snapshot copies |
max_files_available |
integer |
Maximum files available for Snapshot copies |
max_files_used |
integer |
Files in use by Snapshot copies |
block_storage
| Name | Type | Description |
|---|---|---|
aggregate_metadata |
integer |
Space used by different metafiles and internal operations inside the aggregate, in bytes. |
aggregate_metadata_percent |
integer |
Aggregate metadata as a percentage. |
available |
integer |
Space available in bytes. |
data_compacted_count |
integer |
Amount of compacted data in bytes. |
data_compaction_space_saved |
integer |
Space saved in bytes by compacting the data. |
data_compaction_space_saved_percent |
integer |
Percentage saved by compacting the data. |
full_threshold_percent |
integer |
The aggregate used percentage at which 'monitor.volume.full' EMS is generated. |
inactive_user_data |
integer |
The size that is physically used in the block storage and has a cold temperature, in bytes. This property is only supported if the aggregate is either attached to a cloud store or can be attached to a cloud store. 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 block_storage.inactive_user_data or **. |
inactive_user_data_percent |
integer |
The percentage of inactive user data in the block storage. This property is only supported if the aggregate is either attached to a cloud store or can be attached to a cloud store. 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 block_storage.inactive_user_data_percent or **. |
physical_used |
integer |
Total physical used size of an aggregate in bytes. |
physical_used_percent |
integer |
Physical used percentage. |
size |
integer |
Total usable space in bytes, not including WAFL reserve and aggregate Snapshot copy reserve. |
used |
integer |
Space used or reserved in bytes. Includes volume guarantees and aggregate metadata. |
used_including_snapshot_reserve |
integer |
Total used including the Snapshot copy reserve, in bytes. |
used_including_snapshot_reserve_percent |
integer |
Total used including the Snapshot reserve as a percentage. |
used_percent |
integer |
Aggregate used percentage. |
volume_deduplication_shared_count |
integer |
Amount of shared bytes counted by storage efficiency. |
volume_deduplication_space_saved |
integer |
Amount of space saved in bytes by storage efficiency. |
volume_deduplication_space_saved_percent |
integer |
Percentage of space saved by storage efficiency. |
volume_footprints_percent |
integer |
A summation of volume footprints inside the aggregate, as a percentage. A volume's footprint is the amount of space being used for the volume in the aggregate. |
cloud_storage
| Name | Type | Description |
|---|---|---|
used |
integer |
Used space in bytes in the cloud store. Only applicable for aggregates with a cloud store tier. |
efficiency
Storage efficiency.
| Name | Type | Description |
|---|---|---|
auto_adaptive_compression_savings |
boolean |
Indicates whether or not aggregate has auto adaptive compression savings. |
cross_volume_background_dedupe |
boolean |
Indicates whether or not cross volume background deduplication is enabled. |
cross_volume_dedupe_savings |
boolean |
Indicates whether or not aggregate has cross volume deduplication savings. |
cross_volume_inline_dedupe |
boolean |
Indicates whether or not cross volume inline deduplication is enabled. |
enable_workload_informed_tsse |
boolean |
Indicates whether Workload Informed TSSE is enabled on the system. |
logical_used |
integer |
Logical used |
ratio |
number |
Data reduction ratio (logical_used / used) |
savings |
integer |
Space saved by storage efficiencies (logical_used - used) |
wise_tsse_min_used_capacity_pct |
integer |
Minimum amount of used data in aggregate required to trigger cold compression on TSSE volumes. |
efficiency_without_snapshots
Storage efficiency that does not include the savings provided by Snapshot copies.
| Name | Type | Description |
|---|---|---|
logical_used |
integer |
Logical used |
ratio |
number |
Data reduction ratio (logical_used / used) |
savings |
integer |
Space saved by storage efficiencies (logical_used - used) |
efficiency_without_snapshots_flexclones
Storage efficiency that does not include the savings provided by Snapshot copies and Flexclone volumes.
| Name | Type | Description |
|---|---|---|
logical_used |
integer |
Logical used |
ratio |
number |
Data reduction ratio (logical_used / used) |
savings |
integer |
Space saved by storage efficiencies (logical_used - used) |
snapshot
| Name | Type | Description |
|---|---|---|
available |
integer |
Available space for Snapshot copies in bytes |
reserve_percent |
integer |
Percentage of space reserved for Snapshot copies |
total |
integer |
Total space for Snapshot copies in bytes |
used |
integer |
Space used by Snapshot copies in bytes |
used_percent |
integer |
Percentage of disk space used by Snapshot copies |
space
| Name | Type | Description |
|---|---|---|
block_storage |
||
cloud_storage |
||
efficiency |
Storage efficiency. |
|
efficiency_without_snapshots |
Storage efficiency that does not include the savings provided by Snapshot copies. |
|
efficiency_without_snapshots_flexclones |
Storage efficiency that does not include the savings provided by Snapshot copies and Flexclone volumes. |
|
footprint |
integer |
A summation of volume footprints (including volume guarantees), in bytes. This includes all of the volume footprints in the block_storage tier and the cloud_storage tier. 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 **. |
snapshot |
iops_raw
The number of I/O operations observed at the storage object. This can be used along with delta time to calculate the rate of I/O operations per unit of time.
| Name | Type | Description |
|---|---|---|
other |
integer |
Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on. |
read |
integer |
Performance metric for read I/O operations. |
total |
integer |
Performance metric aggregated over all types of I/O operations. |
write |
integer |
Peformance metric for write I/O operations. |
latency_raw
The raw latency in microseconds observed at the storage object. This can be divided by the raw IOPS value to calculate the average latency per I/O operation.
| Name | Type | Description |
|---|---|---|
other |
integer |
Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on. |
read |
integer |
Performance metric for read I/O operations. |
total |
integer |
Performance metric aggregated over all types of I/O operations. |
write |
integer |
Peformance metric for write I/O operations. |
throughput_raw
Throughput bytes observed at the storage object. This can be used along with delta time to calculate the rate of throughput bytes per unit of time.
| Name | Type | Description |
|---|---|---|
other |
integer |
Performance metric for other I/O operations. Other I/O operations can be metadata operations, such as directory lookups and so on. |
read |
integer |
Performance metric for read I/O operations. |
total |
integer |
Performance metric aggregated over all types of I/O operations. |
write |
integer |
Peformance metric for write I/O operations. |
statistics
The real time I/O statistics for the aggregate.
| Name | Type | Description |
|---|---|---|
iops_raw |
The number of I/O operations observed at the storage object. This can be used along with delta time to calculate the rate of I/O operations per unit of time. |
|
latency_raw |
The raw latency in microseconds observed at the storage object. This can be divided by the raw IOPS value to calculate the average latency per I/O operation. |
|
status |
string |
Errors associated with the sample. For example, if the aggregation of data over multiple nodes fails, then any partial errors might return "ok" on success or "error" on an internal uncategorized failure. Whenever a sample collection is missed but done at a later time, it is back filled to the previous 15 second timestamp and tagged with "backfilled_data". "Inconsistent_ delta_time" is encountered when the time between two collections is not the same for all nodes. Therefore, the aggregated value might be over or under inflated. "Negative_delta" is returned when an expected monotonically increasing value has decreased in value. "Inconsistent_old_data" is returned when one or more nodes do not have the latest data. |
throughput_raw |
Throughput bytes observed at the storage object. This can be used along with delta time to calculate the rate of throughput bytes per unit of time. |
|
timestamp |
string |
The timestamp of the performance data. |
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
returned_error
| Name | Type | Description |
|---|---|---|
arguments |
array[error_arguments] |
Message arguments |
code |
string |
Error code |
message |
string |
Error message |
target |
string |
The target parameter that caused the error. |