Skip to main content

Retrieve consistency group Snapshot copies

Contributors
PDFs

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

Introduced In: 9.10

Retrieves Snapshot copies 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.

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

uuid

string

query

False

Filter by uuid

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 call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

collection_links

num_records

integer

Number of records.

records

array[records]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "comment": "My Snapshot copy comment",
      "consistency_group": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "my_consistency_group",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "consistency_type": "crash",
      "create_time": "2020-10-25 07:20:00 -0400",
      "is_partial": "",
      "luns": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "/vol/volume1/lun1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "missing_volumes": [
        {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "name": "volume1",
          "uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
        }
      ],
      "name": "string",
      "namespaces": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "/vol/volume1/namespace1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "restore_size": 4096,
      "size": 4096,
      "snaplock_expiry_time": "2019-02-04 14:00:00 -0500",
      "snapmirror_label": "sm_label",
      "snapshot_volumes": [
        {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "snapshot": {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "name": "this_snapshot",
            "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
          },
          "volume": {
            "_links": {
              "self": {
                "href": "/api/resourcelink"
              }
            },
            "name": "volume1",
            "uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
          }
        }
      ],
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      },
      "svm_dr": {
        "label": {
          "name": "string"
        }
      },
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    }
  ]
}

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
Name Type Description

next

href

self

href
Name Type Description

self

href

consistency_group

The consistency group of the Snapshot copy.

Name Type Description

_links

self_link

name

string

The name of the consistency group.

uuid

string

The unique identifier of the consistency group.

_links

Name Type Description

self

href

luns

The list of LUNs in this Snapshot copy.

Name Type Description

_links

_links

name

string

The fully qualified path name of the LUN composed of the "/vol" prefix, the volume name, the (optional) qtree name, and base name of the LUN. Valid in POST and PATCH.

uuid

string

The unique identifier of the LUN.

volume_reference

Name Type Description

_links

_links

name

string

The name of the volume. This field cannot be specified in a POST or PATCH method.

uuid

string

Unique identifier for the volume. This corresponds to the instance-uuid that is exposed in the CLI and ONTAPI. It does not change due to a volume move.

  • example: 028baa66-41bd-11e9-81d5-00a0986138f7

  • Introduced in: 9.6

  • x-nullable: true

namespaces

The list of NVMe namespaces in this Snapshot copy.

Name Type Description

_links

_links

name

string

The fully qualified path name of the NVMe namespace composed from the volume name, qtree name and base name of the namespace.

uuid

string

The unique identifier of the NVMe namespace.

snapshot_reference

Name Type Description

_links

_links

name

string

uuid

string

consistency_group_volume_snapshot

Name Type Description

_links

self_link

snapshot

snapshot_reference

volume

volume_reference

svm_reference

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.

label

SVM DR label and attributes for the Snapshot copy.

Name Type Description

hold

boolean

Specifies if the SVM DR label's hold attributes must be set. The default is false.

name

string

The SVM DR label for the Snapshot copy.

svm_dr

SVM DR attributes.

Name Type Description

label

label

SVM DR label and attributes for the Snapshot copy.

records

Name Type Description

_links

self_link

comment

string

Comment for the Snapshot copy.

consistency_group

consistency_group

The consistency group of the Snapshot copy.

consistency_type

string

Consistency type. This is for categorization purposes only. A Snapshot copy should not be set to 'application consistent' unless the host application is quiesced for the Snapshot copy. Valid in POST.

create_time

string

Time the snapshot copy was created

is_partial

boolean

Indicates whether the Snapshot copy taken is partial or not.

luns

luns

The list of LUNs in this Snapshot copy.

missing_volumes

array[volume_reference]

List of volumes which are not in the Snapshot copy.

name

string

Name of the Snapshot copy.

namespaces

namespaces

The list of NVMe namespaces in this Snapshot copy.

reclaimable_space

integer

Space reclaimed when the Snapshot copy is deleted, in bytes.

restore_size

integer

Size of the consistency group if this Snapshot copy is restored.

size

integer

Size of the active file system at the time the Snapshot copy is captured. The actual size of the Snapshot copy also includes those blocks trapped by other Snapshot copies. On a Snapshot copy deletion, the "size" amount of blocks is the maximum number of blocks available. On a Snapshot copy restore, the "afs-used size" value will match the Snapshot copy "size" value.

snaplock_expiry_time

string

SnapLock expiry time for the Snapshot copy, if the Snapshot copy is taken on a SnapLock consistency group. A Snapshot copy is not allowed to be deleted or renamed until the SnapLock ComplianceClock time goes beyond its retention time. This option can be set during Snapshot copy POST and Snapshot copy PATCH on Snapshot copy locking enabled consistency groups.

snapmirror_label

string

Snapmirror Label for the Snapshot copy.

snapshot_volumes

array[consistency_group_volume_snapshot]

List of volume and snapshot identifiers for each volume in the Snapshot copy.

svm

svm_reference

SVM, applies only to SVM-scoped objects.

svm_dr

svm_dr

SVM DR attributes.

uuid

string

The unique identifier of the Snapshot copy. The UUID is generated by ONTAP when the Snapshot copy is created.

  • example: 1cd8a442-86d1-11e0-ae1c-123478563412

  • readOnly: 1

  • Introduced in: 9.6

  • x-nullable: true

write_fence

boolean

Specifies whether a write fence will be taken when creating the Snapshot copy. The default is false if there is only one volume in the consistency group, otherwise the default is true.

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.