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

Delete a consistency group

Contributors

DELETE /application/consistency-groups/{uuid}

Introduced In: 9.10

Deletes a consistency group.

Note this will not delete any associated volumes or LUNs. To remove those elements, you can use the appropriate object endpoint.

There are no ONTAP commands for managing consistency groups.

Parameters

Name Type In Required Description

uuid

string

path

True

The unique identifier of the consistency group to delete.

delete_data

boolean

query

False

Delete the underlying storage as well as the consistency group association. This parameter should be used with caution.

  • Default value:

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

53411842

Consistency group does not exist.

53411843

A consistency group with specified UUID was not found.

53411844

Specified consistency group was not found in the specified SVM.

53411845

The specified UUID and name refer to different consistency groups.

53411846

Either name or UUID must be provided.

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

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.