Complete a consistency group Snapshot copy operation
- PDF of this doc site
Collection of separate PDF docs
Creating your file...
PATCH /application/consistency-groups/{consistency_group.uuid}/snapshots/{uuid}
Introduced In: 9.11
Completes a Snapshot copy operation of a consistency group.
Example
Completing a Snapshot copy operation
The following example shows how to complete the Snapshot copy operation by committing an existing Snapshot copy 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:
{ }
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
consistency_group.uuid |
string |
path |
True |
Unique identifier of the consistency group's Snapshot copy for deletion. |
uuid |
string |
path |
True |
Snapshot copy UUID. |
action |
string |
query |
False |
Commits the Snapshot copy. 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 copy create operation is aborted.
|
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.
|
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 copy operation for consistency group. |
Also see the table of common errors in the Response body overview section of this documentation.
Name | Type | Description |
---|---|---|
error |
Example error
{
"error": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist",
"target": "uuid"
}
}
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. |