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

Create a volume Snapshot copy

Contributors
PDFs

POST /storage/volumes/{volume.uuid}/snapshots

Creates a volume Snapshot copy.

Required properties

  • name - Name of the Snapshot copy to be created.

  • comment - Comment associated with the Snapshot copy.

  • expiry_time - Snapshot copies with an expiry time set are not allowed to be deleted until the retention time is reached.

  • snapmirror_label - Label for SnapMirror operations.

  • snapshot create

Learn more

Parameters

Name Type In Required Description

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.

volume.uuid

string

path

True

Volume UUID

Request Body

Name Type Description

_links

_links

comment

string

A comment associated with the Snapshot copy. This is an optional attribute for POST or PATCH.

create_time

string

Creation time of the Snapshot copy. It is the volume access time when the Snapshot copy was created.

expiry_time

string

The expiry time for the Snapshot copy. This is an optional attribute for POST or PATCH. Snapshot copies with an expiry time set are not allowed to be deleted until the retention time is reached.

name

string

Snapshot copy. Valid in POST or PATCH.

owners

array[string]

snaplock_expiry_time

string

SnapLock expiry time for the Snapshot copy, if the Snapshot copy is taken on a SnapLock volume. A Snapshot copy is not allowed to be deleted or renamed until the SnapLock ComplianceClock time goes beyond this retention time.

snapmirror_label

string

Label for SnapMirror operations

state

string

State of the Snapshot copy. There are cases where some Snapshot copies are not complete. In the "partial" state, the Snapshot copy is consistent but exists only on the subset of the constituents that existed prior to the FlexGroup's expansion. Partial Snapshot copies cannot be used for a Snapshot copy restore operation. A Snapshot copy is in an "invalid" state when it is present in some FlexGroup constituents but not in others. At all other times, a Snapshot copy is valid.

svm

svm

uuid

string

The UUID of the Snapshot copy in the volume that uniquely identifies the Snapshot copy in that volume.

volume

volume
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "comment": "string",
  "create_time": "2019-02-04 19:00:00 UTC",
  "expiry_time": "2019-02-04 19:00:00 UTC",
  "name": "this_snapshot",
  "owners": [
    "string"
  ],
  "snaplock_expiry_time": "2019-02-04 19:00:00 UTC",
  "snapmirror_label": "string",
  "state": "string",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412",
  "volume": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "volume1",
    "uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
  }
}

Response

Status: 202, Accepted
Name Type Description

job

job_link
Example response 
{
  "job": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "uuid": "string"
  }
}

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

self

href

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

snapshot

The Snapshot copy object represents a point in time Snapshot copy of a volume.

Name Type Description

_links

_links

comment

string

A comment associated with the Snapshot copy. This is an optional attribute for POST or PATCH.

create_time

string

Creation time of the Snapshot copy. It is the volume access time when the Snapshot copy was created.

expiry_time

string

The expiry time for the Snapshot copy. This is an optional attribute for POST or PATCH. Snapshot copies with an expiry time set are not allowed to be deleted until the retention time is reached.

name

string

Snapshot copy. Valid in POST or PATCH.

owners

array[string]

snaplock_expiry_time

string

SnapLock expiry time for the Snapshot copy, if the Snapshot copy is taken on a SnapLock volume. A Snapshot copy is not allowed to be deleted or renamed until the SnapLock ComplianceClock time goes beyond this retention time.

snapmirror_label

string

Label for SnapMirror operations

state

string

State of the Snapshot copy. There are cases where some Snapshot copies are not complete. In the "partial" state, the Snapshot copy is consistent but exists only on the subset of the constituents that existed prior to the FlexGroup's expansion. Partial Snapshot copies cannot be used for a Snapshot copy restore operation. A Snapshot copy is in an "invalid" state when it is present in some FlexGroup constituents but not in others. At all other times, a Snapshot copy is valid.

svm

svm

uuid

string

The UUID of the Snapshot copy in the volume that uniquely identifies the Snapshot copy in that volume.

volume

volume
Name Type Description

_links

_links

uuid

string

The UUID of the asynchronous job that is triggered by a POST, PATCH, or DELETE operation.

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.