Skip to main content
REST API reference

Report cluster-wide storage details across different tiers

PDFs

GET /storage/cluster

Introduced In: 9.6

Retrieves cluster-wide storage details across the different tiers. By default, this endpoint returns all fields. Storage details include storage efficiency, block storage and cloud storage information. Supports the following roles: admin, and readonly.

Parameters

Name Type In Required Description

block_storage.size

integer

query

False

Filter by block_storage.size

  • Introduced in: 9.14

block_storage.available

integer

query

False

Filter by block_storage.available

  • Introduced in: 9.14

block_storage.medias.type

string

query

False

Filter by block_storage.medias.type

  • Introduced in: 9.14

block_storage.medias.used

integer

query

False

Filter by block_storage.medias.used

  • Introduced in: 9.14

block_storage.medias.efficiency_without_snapshots.logical_used

integer

query

False

Filter by block_storage.medias.efficiency_without_snapshots.logical_used

  • Introduced in: 9.14

block_storage.medias.efficiency_without_snapshots.ratio

number

query

False

Filter by block_storage.medias.efficiency_without_snapshots.ratio

  • Introduced in: 9.14

block_storage.medias.efficiency_without_snapshots.savings

integer

query

False

Filter by block_storage.medias.efficiency_without_snapshots.savings

  • Introduced in: 9.14

block_storage.medias.efficiency_without_snapshots_flexclones.logical_used

integer

query

False

Filter by block_storage.medias.efficiency_without_snapshots_flexclones.logical_used

  • Introduced in: 9.14

block_storage.medias.efficiency_without_snapshots_flexclones.ratio

number

query

False

Filter by block_storage.medias.efficiency_without_snapshots_flexclones.ratio

  • Introduced in: 9.14

block_storage.medias.efficiency_without_snapshots_flexclones.savings

integer

query

False

Filter by block_storage.medias.efficiency_without_snapshots_flexclones.savings

  • Introduced in: 9.14

block_storage.medias.size

integer

query

False

Filter by block_storage.medias.size

  • Introduced in: 9.14

block_storage.medias.available

integer

query

False

Filter by block_storage.medias.available

  • Introduced in: 9.14

block_storage.medias.efficiency.logical_used

integer

query

False

Filter by block_storage.medias.efficiency.logical_used

  • Introduced in: 9.14

block_storage.medias.efficiency.ratio

number

query

False

Filter by block_storage.medias.efficiency.ratio

  • Introduced in: 9.14

block_storage.medias.efficiency.savings

integer

query

False

Filter by block_storage.medias.efficiency.savings

  • Introduced in: 9.14

block_storage.medias.physical_used

integer

query

False

Filter by block_storage.medias.physical_used

  • Introduced in: 9.14

block_storage.physical_used

integer

query

False

Filter by block_storage.physical_used

  • Introduced in: 9.14

block_storage.used

integer

query

False

Filter by block_storage.used

  • Introduced in: 9.14

block_storage.inactive_data

integer

query

False

Filter by block_storage.inactive_data

  • Introduced in: 9.14

cloud_storage.used

integer

query

False

Filter by cloud_storage.used

  • Introduced in: 9.14

efficiency_without_snapshots.logical_used

integer

query

False

Filter by efficiency_without_snapshots.logical_used

  • Introduced in: 9.14

efficiency_without_snapshots.ratio

number

query

False

Filter by efficiency_without_snapshots.ratio

  • Introduced in: 9.14

efficiency_without_snapshots.savings

integer

query

False

Filter by efficiency_without_snapshots.savings

  • Introduced in: 9.14

efficiency_without_snapshots_flexclones.logical_used

integer

query

False

Filter by efficiency_without_snapshots_flexclones.logical_used

  • Introduced in: 9.14

efficiency_without_snapshots_flexclones.ratio

number

query

False

Filter by efficiency_without_snapshots_flexclones.ratio

  • Introduced in: 9.14

efficiency_without_snapshots_flexclones.savings

integer

query

False

Filter by efficiency_without_snapshots_flexclones.savings

  • Introduced in: 9.14

efficiency.logical_used

integer

query

False

Filter by efficiency.logical_used

  • Introduced in: 9.14

efficiency.ratio

number

query

False

Filter by efficiency.ratio

  • Introduced in: 9.14

efficiency.savings

integer

query

False

Filter by efficiency.savings

  • Introduced in: 9.14

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

block_storage

block_storage

Configuration information for the locally attached portion of the storage across the cluster. When a cloud store is also used by the storage, this is referred to as the performance tier.

cloud_storage

cloud_storage

Configuration information for the cloud storage portion of all the aggregates across the cluster. This is referred to as the capacity tier.

efficiency

efficiency

Storage efficiency.

Platform Specifics

  • Unified ONTAP: Available for GET requests.

  • readOnly: 1

  • Introduced in: 9.6

efficiency_without_snapshots

efficiency_without_snapshots

Storage efficiency that does not include the savings provided by snapshots.

efficiency_without_snapshots_flexclones

efficiency_without_snapshots_flexclones

Storage efficiency that does not include the savings provided by snapshots and FlexClone volumes.

Platform Specifics

  • Unified ONTAP: Available for GET requests.

  • readOnly: 1

  • Introduced in: 9.9
Example response 
{
  "block_storage": {
    "available": 0,
    "inactive_data": 0,
    "medias": [
      {
        "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
        },
        "type": "string"
      }
    ],
    "physical_used": 0,
    "size": 0,
    "used": 0
  },
  "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
  }
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

9240637

This operation is not supported on this platform.

Also see the table of common errors in the Response body overview section of this documentation.

Name Type Description

error

returned_error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

efficiency

Storage efficiency.

=== Platform Specifics

  • Unified ONTAP: Available for GET requests.

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

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 snapshots and FlexClone volumes.

=== Platform Specifics

  • Unified ONTAP: Available for GET requests.

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)

medias

Name Type Description

available

integer

Available space across the cluster based on media type.

efficiency

efficiency

Storage efficiency.

Platform Specifics

  • Unified ONTAP: Available for GET requests.

  • Introduced in: 9.7

efficiency_without_snapshots

efficiency_without_snapshots

Storage efficiency that does not include the savings provided by snapshots.

efficiency_without_snapshots_flexclones

efficiency_without_snapshots_flexclones

Storage efficiency that does not include the savings provided by snapshots and FlexClone volumes.

Platform Specifics

  • Unified ONTAP: Available for GET requests.

  • Introduced in: 9.9

physical_used

integer

Total physical used space across the cluster based on media type.

size

integer

Total space across the cluster based on media type.

type

string

The type of media being used.

used

integer

Used space across the cluster based on media type.

Platform Specifics

  • Unified ONTAP: Available for GET requests.

  • format: int64

  • Introduced in: 9.6

  • x-nullable: true

block_storage

Configuration information for the locally attached portion of the storage across the cluster. When a cloud store is also used by the storage, this is referred to as the performance tier.

Name Type Description

available

integer

Available space across the cluster.

inactive_data

integer

Inactive data across the cluster.

Platform Specifics

  • Unified ONTAP: Available for GET requests.

  • format: int64

  • readOnly: 1

  • Introduced in: 9.7

  • x-nullable: true

medias

array[medias]

Configuration information based on type of media. For example, SSD media type information includes the sum of all the SSD storage across the cluster.

physical_used

integer

Total physical used space across the cluster.

size

integer

Total space across the cluster.

used

integer

Used space (includes volume reserves) across the cluster.

Platform Specifics

  • Unified ONTAP: Available for GET requests.

  • format: int64

  • readOnly: 1

  • Introduced in: 9.6

  • x-nullable: true

cloud_storage

Configuration information for the cloud storage portion of all the aggregates across the cluster. This is referred to as the capacity tier.

Name Type Description

used

integer

Total space used in cloud.

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.