Skip to main content
REST API reference

Complete a consistency group snapshot operation

PDFs

PATCH /application/consistency-groups/{consistency_group.uuid}/snapshots/{uuid}

Introduced In: 9.11

Completes a snapshot operation of a consistency group.

Example

Completing a snapshot operation

The following example shows how to complete the snapshot operation by committing an existing snapshot to disk:

curl -X PATCH https://<mgmt-ip>/api/application/consistency-groups/a8d0626a-17a0-11eb-b141-005056acd498/snapshots/92c6c770-17a1-11eb-b141-005056acd498?action=commit

Response:

{
}

Modifying the SnapLock expiry time of a snapshot in SnapLock for SnapVault

The following example shows how to modify the SnapLock expiry time of a locked snapshot in SnapLock for SnapVault destination:

curl -X PATCH 'https://<mgmt-ip>/api/application/consistency-groups/a8d0626a-17a0-11eb-b141-005056acd498/snapshots/92c6c770-17a1-11eb-b141-005056acd498' -d '{"snaplock.expiry_time" : "2/28/2024 10:11:10 +05:30"}' -H "accept: application/hal+json"

Response:

{
  "job": {
    "uuid": "8c9cabf3-0a88-11ec-a449-005056bbcf9f",
    "_links": {
      "self": {
        "href": "/api/cluster/jobs/8c9cabf3-0a88-11ec-a449-005056bbcf9f"
      }
    }
  }
}

Parameters

Name Type In Required Description

consistency_group.uuid

string

path

True

Unique identifier of the consistency group's snapshot for deletion.

uuid

string

path

True

Snapshot UUID.

action

string

query

False

Commits the snapshot. The commit must be called within the timeout value specified during POST. If the commit is not called within the specified time, then the snapshot create operation is aborted.

  • enum: ["commit"]

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.

  • Default value: 1

  • Max value: 120

  • Min value: 0

Response

Status: 200, Ok

Response

Status: 202, Accepted

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

53411925

Failed to find a previously initiated two-phase snapshot operation for consistency group.

53412015

SnapLock expiry time cannot be before the current expiry time.

53412016

Snapshot is not retained by SnapLock.

53412017

The operation is not supported on this platform.</personalities>

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

Definitions

See Definitions

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.