Skip to main content
A newer release of this product is available.

Retrieve a collection of aggregates for an entire cluster

Contributors
PDFs

GET /storage/aggregates

Retrieves the collection of aggregates for the entire cluster.

Expensive properties

There is an added 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 DOC Requesting specific fields to learn more.

  • space.block_storage.inactive_user_data

  • space.footprint

  • storage aggregate show

Learn more

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

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

state

string

query

False

Filter by state

space.efficiency_without_snapshots.ratio

number

query

False

Filter by space.efficiency_without_snapshots.ratio

space.efficiency_without_snapshots.logical_used

integer

query

False

Filter by space.efficiency_without_snapshots.logical_used

space.efficiency_without_snapshots.savings

integer

query

False

Filter by space.efficiency_without_snapshots.savings

space.cloud_storage.used

integer

query

False

Filter by space.cloud_storage.used

space.footprint

integer

query

False

Filter by space.footprint

space.efficiency.ratio

number

query

False

Filter by space.efficiency.ratio

space.efficiency.logical_used

integer

query

False

Filter by space.efficiency.logical_used

space.efficiency.savings

integer

query

False

Filter by space.efficiency.savings

space.block_storage.size

integer

query

False

Filter by space.block_storage.size

space.block_storage.used

integer

query

False

Filter by space.block_storage.used

space.block_storage.full_threshold_percent

integer

query

False

Filter by space.block_storage.full_threshold_percent

space.block_storage.inactive_user_data

integer

query

False

Filter by space.block_storage.inactive_user_data

space.block_storage.available

integer

query

False

Filter by space.block_storage.available

node.name

string

query

False

Filter by node.name

node.uuid

string

query

False

Filter by node.uuid

name

string

query

False

Filter by name

home_node.name

string

query

False

Filter by home_node.name

home_node.uuid

string

query

False

Filter by home_node.uuid

uuid

string

query

False

Filter by uuid

snaplock_type

string

query

False

Filter by snaplock_type

block_storage.primary.checksum_style

string

query

False

Filter by block_storage.primary.checksum_style

block_storage.primary.raid_type

string

query

False

Filter by block_storage.primary.raid_type

block_storage.primary.raid_size

integer

query

False

Filter by block_storage.primary.raid_size

block_storage.primary.disk_class

string

query

False

Filter by block_storage.primary.disk_class

block_storage.primary.disk_count

integer

query

False

Filter by block_storage.primary.disk_count

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.hybrid_cache.disk_count

integer

query

False

Filter by block_storage.hybrid_cache.disk_count

block_storage.hybrid_cache.enabled

boolean

query

False

Filter by block_storage.hybrid_cache.enabled

block_storage.hybrid_cache.raid_type

string

query

False

Filter by block_storage.hybrid_cache.raid_type

block_storage.hybrid_cache.used

integer

query

False

Filter by block_storage.hybrid_cache.used

block_storage.hybrid_cache.size

integer

query

False

Filter by block_storage.hybrid_cache.size

block_storage.plexes.name

string

query

False

Filter by block_storage.plexes.name

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

create_time

string

query

False

Filter by create_time

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

error

error

num_records

integer

Number of records

records

array[aggregate]

spares

array[aggregate_spare]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  },
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "block_storage": {
        "hybrid_cache": {
          "disk_count": 6,
          "raid_type": "string",
          "size": 1612709888,
          "used": 26501122
        },
        "mirror": {
          "enabled": "",
          "state": "string"
        },
        "plexes": [
          {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "name": "plex0"
          }
        ],
        "primary": {
          "checksum_style": "string",
          "disk_class": "performance",
          "disk_count": 8,
          "raid_size": 16,
          "raid_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 12:00:00 -0400",
      "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"
      },
      "name": "node1_aggr_1",
      "node": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "node1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "snaplock_type": "string",
      "space": {
        "block_storage": {
          "available": 10156560384,
          "full_threshold_percent": 0,
          "inactive_user_data": 304448,
          "size": 10156769280,
          "used": 2088960
        },
        "cloud_storage": {
          "used": 402743264
        },
        "efficiency": {
          "logical_used": 0,
          "ratio": 0,
          "savings": 0
        },
        "efficiency_without_snapshots": {
          "logical_used": 0,
          "ratio": 0,
          "savings": 0
        },
        "footprint": 608896
      },
      "state": "string",
      "uuid": "string"
    }
  ],
  "spares": [
    {
      "checksum_style": "string",
      "disk_class": "solid_state",
      "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",
      "usable": 9
    }
  ]
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

19726382

Another provisioning operation is in progress on this cluster. Wait a few minutes, and try the operation again.

19726344

No recommendation can be made for this cluster.

19726357

Aggregate recommendations are not supported on MetroCluster.

19726358

Aggregate recommendations are not supported on ONTAP Cloud.

19726359

Aggregate recommendations are not supported on ONTAP Select.

19726341

Not enough eligible spare disks are available on the node.

787092

The target field cannot be specified for this operation.
Name Type Description

error

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

next

href

self

href

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

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.

_links

Name Type Description

self

href

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

enabled

boolean

Aggregate uses HDDs with SSDs as a cache

raid_type

string

RAID type for SSD cache of the aggregate. Only provided when hybrid_cache.enabled is 'true'.

size

integer

Total usable space in bytes of SSD cache. Only provided when hybrid_cache.enabled is 'true'.

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

_links

name

string

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.

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.

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

hybrid_cache

Contains the configuration for the hybrid cache. The hybrid cache is made up of either whole SSDs or storage pool SSDs.

mirror

mirror

plexes

array[plex_reference]

Plex reference for each plex in the aggregate.

primary

primary

Configuration information for the primary storage portion of the aggregate. This excludes the hybrid cache details.

cloud_store

Cloud store

Name Type Description

_links

_links

name

string

uuid

string

cloud_storage_tier

Name Type Description

cloud_store

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

Aggregate is eligible for a cloud store to be attached.

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

Aggregate uses self-encrypting drives with data protection enabled.

software_encryption_enabled

boolean

NetApp Aggregate Encryption enabled. All data in the aggregate is encrypted.

dr_home_node

Node where the aggregate belongs 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 belongs after giveback. The value for this field might differ from the value of the 'node' field during takeover.

Name Type Description

_links

_links

name

string

uuid

string

node

Node where the aggregate currently resides.

Name Type Description

_links

_links

name

string

uuid

string

block_storage

Name Type Description

available

integer

Space available in bytes

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

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.

cloud_storage

Name Type Description

used

integer

Used space in bytes in the cloud store. Only applicable for aggregate with a cloud store tier.

efficiency

Storage efficiency

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

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)

space

Name Type Description

block_storage

block_storage

cloud_storage

cloud_storage

efficiency

efficiency

Storage efficiency

efficiency_without_snapshots

efficiency_without_snapshots

Storage efficiency that does not include the savings provided by Snapshot copies

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

aggregate

Name Type Description

_links

_links

block_storage

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

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

data_encryption

dr_home_node

dr_home_node

Node where the aggregate belongs after disaster recovery. The value for this field might differ from the 'node' field during switchover.

home_node

home_node

Node where the aggregate belongs after giveback. The value for this field might differ from the value of the 'node' field during takeover.

name

string

Aggregate name

node

node

Node where the aggregate currently resides.

snaplock_type

string

SnapLock type

space

space

state

string

Operational state of the aggregate

uuid

string

Aggregate UUID

raid_group

Name Type Description

default

integer

Default number of disks in a RAID group

max

integer

Maximum number of disks allowed in a RAID group

min

integer

Minimum number of disks allowed in a RAID group

layout_requirement

Name Type Description

aggregate_min_disks

integer

Minimum number of disks to create an aggregate

default

boolean

Indicates if this RAID type is the default

raid_group

raid_group

raid_type

string

RAID type

node

Node where the spares are assigned

Name Type Description

_links

_links

name

string

uuid

string

aggregate_spare

Name Type Description

checksum_style

string

The checksum type that has been assigned to the spares

disk_class

string

Disk class of spares

layout_requirements

array[layout_requirement]

Available RAID protections and their restrictions

node

node

Node where the spares are assigned

size

integer

Usable size of each spare in bytes

syncmirror_pool

string

SyncMirror spare pool

usable

integer

Total number of usable spares