Skip to main content
REST API reference

Retrieve a shadow copy set

PDFs

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

Introduced In: 9.11

Retrieves a Shadowcopy set

  • vserver cifs shadowcopy show-sets

Learn more

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

SVM, applies only to SVM-scoped objects.

uuid

string

The universally-unique identifier of the storage's shadow copy set.
Example response 
{
  "keep_snapshots": 1,
  "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

returned_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

SVM, applies only to SVM-scoped objects.

Name Type Description

_links

_links

name

string

The name of the SVM. This field cannot be specified in a PATCH method.

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

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.