Skip to main content

Retrieve a consistency group Snapshot copy

Contributors
PDFs

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

Introduced In: 9.10

Retrieves details of a specific snapshot for a consistency group.

Expensive properties

There is an added computational cost to retrieving values for these properties. They are not included by default in GET results and must be explicitly requested using the fields query parameter. See DOC Requesting specific fields to learn more.

  • is_partial

  • missing_voumes.uuid

  • missing_voumes.name

Parameters

Name Type In Required Description

consistency_group.uuid

string

path

True

The unique identifier of the consistency group to retrieve.

uuid

string

path

True

The unique identifier of the Snapshot copy of the consistency group to retrieve.

snapshot_volumes.snapshot.name

string

query

False

Filter by snapshot_volumes.snapshot.name

  • Introduced in: 9.12

snapshot_volumes.snapshot.uuid

string

query

False

Filter by snapshot_volumes.snapshot.uuid

  • Introduced in: 9.12

snapshot_volumes.volume.uuid

string

query

False

Filter by snapshot_volumes.volume.uuid

  • Introduced in: 9.12

snapshot_volumes.volume.name

string

query

False

Filter by snapshot_volumes.volume.name

  • Introduced in: 9.12

comment

string

query

False

Filter by comment

consistency_type

string

query

False

Filter by consistency_type

missing_volumes.uuid

string

query

False

Filter by missing_volumes.uuid

missing_volumes.name

string

query

False

Filter by missing_volumes.name

create_time

string

query

False

Filter by create_time

consistency_group.name

string

query

False

Filter by consistency_group.name

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

is_partial

boolean

query

False

Filter by is_partial

name

string

query

False

Filter by name

snapmirror_label

string

query

False

Filter by snapmirror_label

write_fence

boolean

query

False

Filter by write_fence

  • Introduced in: 9.14

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the cal