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

Retrieves a shadowcopy set

learn more

  • [doc /protocols/cifs/shadow-copies](#docs-nas-protocols_cifs_shadow-copies)

GET /protocols/cifs/shadowcopy-sets/{uuid}

Introduced In: 9.11

Retrieves a Shadowcopy set

  • vserver cifs shadowcopy show-sets

Parameters

Name Type In Required Description

uuid

string

path

True

Storage shadowcopy set ID.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

keep_snapshots

boolean

Request the storage system to keep the snapshot copies taken as a part of the shadow copy set creation.

svm

svm

uuid

string

The universally-unique identifier of the storage's shadow copy set.

Example response
{
  "keep_snapshots": "",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "uuid": "f8328660-00e6-11e6-80d9-005056bd65a9"
}

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

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.

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.

Close
Try it out

Sign in with your NetApp Cloud Central credentials.

Try this API

Parameters

Headers

Body

Code

Response