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

Retrieve a FlexCache volume in the cluster

Contributors
PDFs

GET /storage/flexcache/flexcaches

Introduced In: 9.6

Retrieves FlexCache in the cluster.

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.

  • origins.ip_address - IP address of origin.

  • origins.size - Physical size of origin.

  • origins.state - State of origin.

  • size - Physical size of FlexCache.

  • guarantee.type - Space guarantee style of FlexCache.

  • aggregates.name or aggregates.uuid - Name or UUID of aggregrate of FlexCache volume.

  • path - Fully-qualified path of the owning SVM's namespace where the FlexCache is mounted.

  • volume flexcache show

Learn more

Parameters

Name Type In Required Description

origins.create_time

string

query

False

Filter by origins.create_time

origins.state

string

query

False

Filter by origins.state

origins.size

integer

query

False

Filter by origins.size

origins.cluster.name

string

query

False

Filter by origins.cluster.name

origins.cluster.uuid

string

query

False

Filter by origins.cluster.uuid

origins.ip_address

string

query

False

Filter by origins.ip_address

origins.volume.uuid

string

query

False

Filter by origins.volume.uuid

origins.volume.name

string

query

False

Filter by origins.volume.name

origins.svm.uuid

string

query

False

Filter by origins.svm.uuid

origins.svm.name

string

query

False

Filter by origins.svm.name

uuid

string

query

False

Filter by uuid

guarantee.type

string

query

False

Filter by guarantee.type

  • Introduced in: 9.7

path

string

query

False

Filter by path

constituents_per_aggregate

integer

query

False

Filter by constituents_per_aggregate

size

integer

query

False

Filter by size

global_file_locking_enabled

boolean

query

False

Filter by global_file_locking_enabled

  • Introduced in: 9.9

writeback.enabled

boolean

query

False

Filter by writeback.enabled

  • Introduced in: 9.12

writeback.transfer_limit

integer

query

False

Filter by writeback.transfer_limit

  • Introduced in: 9.12

writeback.scrub_threshold

integer

query

False

Filter by writeback.scrub_threshold

  • Introduced in: 9.12

writeback.per_inode_dirty_limit

integer

query

False

Filter by writeback.per_inode_dirty_limit

  • Introduced in: 9.12

name

string

query

False

Filter by name

  • maxLength: 203

  • minLength: 1

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

dr_cache

boolean

query

False

Filter by dr_cache

  • Introduced in: 9.9

aggregates.name

string

query

False

Filter by aggregates.name

aggregates.uuid

string

query

False

Filter by aggregates.uuid

use_tiered_aggregate

boolean

query

False

Filter by use_tiered_aggregate

  • Introduced in: 9.8

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.

  • Default value: 1

  • Max value: 120

  • Min value: 0

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

order_by

array[string]

query

False

Order results by specified fields and optional [asc

desc] direction. Default direction is 'asc' for ascending.

return_records

boolean

query

False

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[flexcache]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "aggregates": [
        {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "name": "aggr1",
          "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
        }
      ],
      "guarantee": {
        "type": "string"
      },
      "name": "vol1",
      "origins": [
        {
          "cluster": {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "name": "cluster1",
            "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
          },
          "create_time": "2018-06-04T19:00:00Z",
          "ip_address": "10.10.10.7",
          "size": 0,
          "state": "string",
          "svm": {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "name": "svm1",
            "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
          },
          "volume": {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "name": "volume1",
            "uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
          }
        }
      ],
      "path": "/user/my_fc",
      "prepopulate": {
        "dir_paths": [
          "/dir1"
        ],
        "exclude_dir_paths": [
          "/dir1/dir2"
        ]
      },
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    }
  ]
}

Error

Status: Default, Error
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

_links

Name Type Description

self

href

aggregates

Name Type Description

_links

_links

name

string

uuid

string

guarantee

Name Type Description

type

string

The type of space guarantee of this volume in the aggregate.

cluster

Name Type Description

_links

_links

name

string

uuid

string

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

volume

Name Type Description

_links

_links

name

string

The name of the volume.

uuid

string

Unique identifier for the volume. This corresponds to the instance-uuid that is exposed in the CLI and ONTAPI. It does not change due to a volume move.

  • example: 028baa66-41bd-11e9-81d5-00a0986138f7

  • Introduced in: 9.6

flexcache_relationship

Name Type Description

cluster

cluster

create_time

string

Creation time of the relationship.

ip_address

string

Cluster managerment IP of the remote cluster.

size

integer

Size of the remote volume.

state

string

Volume state

svm

svm

volume

volume

prepopulate

FlexCache prepopulate

Name Type Description

dir_paths

array[string]

exclude_dir_paths

array[string]

recurse

boolean

Specifies whether or not the prepopulate action should search through the dir_paths recursively. If not set, the default value true is used.

svm

FlexCache SVM

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

writeback

FlexCache Writeback

Name Type Description

enabled

boolean

Indicates whether or not writeback is enabled for the FlexCache volume. Writeback is a storage method where data is first written to the FlexCache volume and then written to the origin of a FlexCache volume.

per_inode_dirty_limit

integer

Specifies the amount of data in 4KB blocks that the system can write per inode in a FlexCache volume before a writeback is initiated for that inode. This property is only relevant to a FlexCache Volume with the writeback property enabled.

scrub_threshold

integer

Specifies the threshold value in 4KB data blocks which when hit will trigger a scrub that will initiate writeback for all dirty inodes on the FlexCache volume. This property is only relevant to a FlexCache Volume with the writeback property enabled.

transfer_limit

integer

Specifies the maximum number of 4KB data blocks the system can transfer, at one time, from the cache to the origin. This process will keep on recurring until all the dirty blocks for the inode are transferred to the origin volume. This property is only relevant to a FlexCache Volume with the writeback property enabled.

flexcache

Defines the cache endpoint of FlexCache.

Name Type Description

_links

_links

aggregates

array[aggregates]

constituents_per_aggregate

integer

Number of FlexCache constituents per aggregate when the 'aggregates' field is mentioned.

dr_cache

boolean

If set to true, a DR cache is created.

global_file_locking_enabled

boolean

Specifies whether or not a FlexCache volume has global file locking mode enabled. Global file locking mode is a mode where protocol read locking semantics are enforced across all FlexCaches and origins of a FlexCache volume. When global file locking mode is enabled, the "is_disconnected_mode_off_for_locks" flag is always set to "true".

guarantee

guarantee

name

string

FlexCache name

origins

array[flexcache_relationship]

path

string

The fully-qualified path in the owning SVM's namespace at which the FlexCache is mounted. The path is case insensitive and must be unique within a SVM's namespace. Path must begin with '/' and must not end with '/'. Only one FlexCache be mounted at any given junction path.

prepopulate

prepopulate

FlexCache prepopulate

size

integer

Physical size of the FlexCache. The recommended size for a FlexCache is 10% of the origin volume. The minimum FlexCache constituent size is 1GB.

svm

svm

FlexCache SVM

use_tiered_aggregate

boolean

Specifies whether or not a Fabricpool-enabled aggregate can be used in FlexCache creation. The use_tiered_aggregate is only used when auto-provisioning a FlexCache volume.

uuid

string

FlexCache UUID. Unique identifier for the FlexCache.

writeback

writeback

FlexCache Writeback

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.