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

Retrieve the origin of a FlexCache volume in the cluster

Contributors
PDFs

GET /storage/flexcache/origins

Introduced In: 9.6

Retrieves origin of FlexCache in the 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 Requesting specific fields to learn more.

  • flexcaches.ip_address - IP address of FlexCache.

  • flexcaches.size - Physical size of FlexCache.

  • flexcaches.guarantee.type - Space guarantee style of FlexCache.

  • flexcaches.state - State of FlexCache.

  • volume flexcache origin show-caches

Learn more

Parameters

Name Type In Required Description

block_level_invalidation

boolean

query

False

Filter by block_level_invalidation

  • Introduced in: 9.9

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

name

string

query

False

Filter by name

global_file_locking_enabled

boolean

query

False

Filter by global_file_locking_enabled

  • Introduced in: 9.9

flexcaches.size

integer

query

False

Filter by flexcaches.size

flexcaches.create_time

string

query

False

Filter by flexcaches.create_time

flexcaches.volume.name

string

query

False

Filter by flexcaches.volume.name

flexcaches.volume.uuid

string

query

False

Filter by flexcaches.volume.uuid

flexcaches.svm.uuid

string

query

False

Filter by flexcaches.svm.uuid

flexcaches.svm.name

string

query

False

Filter by flexcaches.svm.name

flexcaches.state

string

query

False

Filter by flexcaches.state

flexcaches.cluster.name

string

query

False

Filter by flexcaches.cluster.name

flexcaches.cluster.uuid

string

query

False

Filter by flexcaches.cluster.uuid

flexcaches.ip_address

string

query

False

Filter by flexcaches.ip_address

uuid

string

query

False

Filter by uuid

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_origin]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "flexcaches": {
      "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": "error",
      "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"
      }
    },
    "name": "vol1, vol_2",
    "svm": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "svm1",
      "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
    },
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563512"
  }
}

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

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

svm

Origin volume SVM

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

flexcache_origin

Defines the origin endpoint of FlexCache.

Name Type Description

_links

_links

block_level_invalidation

boolean

Block level invalidation enables the FlexCache volume to retain blocks that are not changed at the FlexCache volume without having to evict them. This means that the FlexCache volume does not have to again incur the cost of fetching blocks over the WAN from the FlexCache volume origin on the next client access. Block level invalidation is a property of the origin volume. Without block level invalidation, any write at the origin volume would evict the whole file at the FlexCache volume, since by default, origin volume does a file level invalidation.

flexcaches

array[flexcache_relationship]

global_file_locking_enabled

boolean

Specifies whether a global file locking option is enabled for an origin volume of a FlexCache volume.

name

string

Origin volume name

svm

svm

Origin volume SVM

uuid

string

Origin volume UUID. Unique identifier for origin of FlexCache.

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.