REST API reference
Create a collection of aggregates for an entire cluster
Suggest changes
PDFs
POST /storage/aggregates
Introduced In: 9.6
Automatically creates aggregates based on an optimal layout recommended by the system. Alternatively, properties can be provided to create an aggregate according to the requested specification. This request starts a job and returns a link to that job. POST operations will be blocked while one or more nodes in the cluster are simulating or implementing automatic aggregate creation.
Required properties
Properties are not required for this API. The following properties are only required if you want to specify properties for aggregate creation:
-
name- Name of the aggregate. -
node.nameornode.uuid- Node on which the aggregate will be created. -
block_storage.primary.disk_count- Number of disks to be used to create the aggregate.
Default values
If not specified in POST, the following default values are assigned. The remaining unspecified properties will receive system dependent default values.
-
block_storage.mirror.enabled- false -
snaplock_type- non_snaplock
Related ONTAP commands
-
storage aggregate auto-provision -
storage aggregate create
Example:
POST /api/storage/aggregates {"node": {"name": "node1"}, "name": "test", "block_storage": {"primary": {"disk_count": "10"}}}
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
disk_size |
integer |
query |
False |
If set, POST only selects disks of the specified size. |
return_timeout |
integer |
query |
False |
The number of seconds to allow the call to execute before returning. When doing a POST, PATCH, or DELETE operation on a single record, the default is 0 seconds. This means that if an asynchronous operation is started, the server immediately returns HTTP code 202 (Accepted) along with a link to the job. If a non-zero value is specified for POST, PATCH, or DELETE operations, ONTAP waits that length of time to see if the job completes so it can return something other than 202.
|
return_records |
boolean |
query |
False |
The default is false. If set to true, the records are returned.
|
Request Body
| 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. |
|
recommendation_spares |
array[aggregate_spare] |
Information on the aggregate's remaining hot spare disks. |
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 request
{
"_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 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"
},
"recommendation_spares": [
{
"checksum_style": "string",
"disk_class": "solid_state",
"disk_type": "string",
"is_partition": 1,
"layout_requirements": [
{
"aggregate_min_disks": 6,
"raid_group": {
"default": 16,
"max": 28,
"min": 5
},
"raid_type": "string"
}
],
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"size": 10156769280,
"syncmirror_pool": "string",
"total": 10,
"usable": 9
}
],
"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
},
"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
}Response
Status: 202, Accepted| Name | Type | Description |
|---|---|---|
job |
||
num_records |
integer |
Number of records |
records |
array[aggregate] |
|
warnings |
array[aggregate_warning] |
List of validation warnings and remediation advice for the aggregate simulate behavior. |
Example response
{
"job": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"uuid": "string"
},
"num_records": 1,
"records": [
{
"_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 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"
},
"recommendation_spares": [
{
"checksum_style": "string",
"disk_class": "solid_state",
"disk_type": "string",
"is_partition": 1,
"layout_requirements": [
{
"aggregate_min_disks": 6,
"raid_group": {
"default": 16,
"max": 28,
"min": 5
},
"raid_type": "string"
}
],
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"size": 10156769280,
"syncmirror_pool": "string",
"total": 10,
"usable": 9
}
],
"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
},
"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
}
],
"warnings": [
{
"action": {
"arguments": [
"string"
],
"message": "string"
},
"name": "string",
"warning": {
"arguments": [
"string"
],
"message": "string"
}
}
]
}Headers
| Name | Description | Type |
|---|---|---|
Location |
Useful for tracking the resource location |
string |
Response
Status: 201, CreatedError
Status: DefaultONTAP Error Response Codes
| Error Code | Description |
|---|---|
460770 |
The aggregate create job failed to create the aggregate. |
786438 |
Failed to create an aggregate on the node. |
786439 |
An aggregate already uses the specified name. |
786446 |
The node is not in cluster. |
786468 |
VLDB is offline. |
786819 |
The value is invalid for the specified option at the current privilege level. |
786902 |
RAID-TEC aggregate is not fully supported. |
786911 |
Not every node in the cluster has the Data ONTAP version required for the feature. |
787069 |
Node is setup for MetroCluster over IP configuration; creating an unmirrored aggregate is not supported in this configuration. |
787092 |
The target field cannot be specified for this operation. |
918138 |
Internal error. Failed to get encryption operation status. |
1114292 |
The required SnapLock license is not installed. |
2425736 |
No matching node found for the target UUID. |
19726341 |
Not enough eligible spare disks are available on the node. |
19726344 |
No recommendation can be made for this cluster. |
19726357 |
Automatic aggregate creation is not supported on MetroCluster with Fibre Channel (FC). |
19726358 |
Automatic aggregate creation is not supported on ONTAP Cloud. |
19726373 |
Recommendation specified for creating aggregates is not current. |
19726378 |
Failed to create recommended aggregates on one or more nodes. |
19726382 |
Another provisioning operation is in progress on this cluster. Wait a few minutes, and try the operation again. |
19726386 |
Encountered an error when retrieving licensing information on this cluster. |
19726387 |
No recommendation can be provided for this cluster within the license capacity. |
19726401 |
Aggregate recommendations are not supported when the DR group is not in the "normal" state. |
19726402 |
Internal error. Unable to determine the MetroCluster configuration state. |
19726403 |
Aggregate recommendation is not supported when there are no healthy target connections to remote storage. |
196608055 |
Aggregate recommendation is not supported on this node because it does not support NetApp Aggregate Encryption (NAE). |
196608206 |
Internal error. Failed to get encryption operation status. |
| 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 |
|---|