Skip to main content
REST API reference

Retrieve a consistency group snapshot

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_volumes.uuid

  • missing_volumes.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 of the consistency group to retrieve.

is_partial

boolean

query

False

Filter by is_partial

comment

string

query

False

Filter by comment

missing_volumes.uuid

string

query

False

Filter by missing_volumes.uuid

missing_volumes.name

string

query

False

Filter by missing_volumes.name

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

snapshot_volumes.snapshot.uuid

string

query

False

Filter by snapshot_volumes.snapshot.uuid

  • Introduced in: 9.12

snapshot_volumes.snapshot.name

string

query

False

Filter by snapshot_volumes.snapshot.name

  • Introduced in: 9.12

reclaimable_space

integer

query

False

Filter by reclaimable_space

  • Introduced in: 9.16

namespaces.name

string

query

False

Filter by namespaces.name

  • Introduced in: 9.16

namespaces.uuid

string

query

False

Filter by namespaces.uuid

  • Introduced in: 9.16

write_fence

boolean

query

False

Filter by write_fence

  • Introduced in: 9.14

create_time

string

query

False

Filter by create_time

restore_size

integer

query

False

Filter by restore_size

  • Introduced in: 9.16

missing_luns.name

string

query

False

Filter by missing_luns.name

  • Introduced in: 9.16

missing_luns.uuid

string

query

False

Filter by missing_luns.uuid

  • Introduced in: 9.16

svm.name

string

query

False

Filter by svm.name

svm.uuid

string

query

False

Filter by svm.uuid

luns.name

string

query

False

Filter by luns.name

  • Introduced in: 9.16

luns.uuid

string

query

False

Filter by luns.uuid

  • Introduced in: 9.16

missing_namespaces.name

string

query

False

Filter by missing_namespaces.name

  • Introduced in: 9.16

missing_namespaces.uuid

string

query

False

Filter by missing_namespaces.uuid

  • Introduced in: 9.16

name

string

query

False

Filter by name

consistency_group.name

string

query

False

Filter by consistency_group.name

consistency_type

string

query

False

Filter by consistency_type

snapmirror_label

string

query

False

Filter by snapmirror_label

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

self_link

comment

string

Comment for the snapshot.

consistency_group

consistency_group

The consistency group of the snapshot.

consistency_type

string

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

create_time

string

Time the snapshot copy was created

is_partial

boolean

Indicates whether the snapshot taken is partial or not.

luns

array[luns]

The list of LUNs in this snapshot.

missing_luns

array[lun_reference]

List of LUNs that are not in the snapshot.

missing_namespaces

array[missing_namespaces]

List of NVMe namespaces that are not in the snapshot.

missing_volumes

array[volume_reference]

List of volumes which are not in the snapshot.

name

string

Name of the snapshot.

namespaces

array[namespaces]

The list of NVMe namespaces in this snapshot.

reclaimable_space

integer

Space reclaimed when the snapshot is deleted, in bytes.

restore_size

integer

Size of the consistency group if this snapshot is restored.

snapmirror_label

string

Snapmirror Label for the snapshot.

snapshot_volumes

array[consistency_group_volume_snapshot]

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

svm

svm_reference

SVM, applies only to SVM-scoped objects.

uuid

string

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

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

  • readOnly: 1

  • Introduced in: 9.10

  • x-nullable: true

write_fence

boolean

Specifies whether a write fence will be taken when creating the snapshot. The default is false if there is only one volume in the consistency group, otherwise the default is true.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "comment": "My snapshot 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_luns": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "/vol/volume1/lun1",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    }
  ],
  "missing_namespaces": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "/vol/volume1/namespace1",
      "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"
    }
  ],
  "reclaimable_space": 0,
  "restore_size": 4096,
  "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"
  },
  "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

self

href

consistency_group

The consistency group of the snapshot.

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

A reference to a LUN.

Name Type Description

_links

_links

name

string

The name of a LUN. A LUN is located within a volume. Optionally, it can be located within a qtree in a volume.

LUN names are paths of the form "/vol/<volume>[/<qtree>]/<namespace>" where the qtree name is optional.

uuid

string

The unique identifier of the LUN.

lun_reference

A reference to a LUN.

Name Type Description

_links

_links

name

string

The name of a LUN. A LUN is located within a volume. Optionally, it can be located within a qtree in a volume.

LUN names are paths of the form "/vol/<volume>[/<qtree>]/<namespace>" where the qtree name is optional.

uuid

string

The unique identifier of the LUN.

missing_namespaces

A reference to a namespace.

Name Type Description

_links

_links

name

string

The name of an NVMe namespace. An NVMe namespace is located within a volume. Optionally, it can be located within a qtree in a volume.

NVMe namespace names are paths of the form "/vol/<volume>[/<qtree>]/<namespace>" where the qtree name is optional.

uuid

string

The unique identifier of the NVMe namespace.

volume_reference

Name Type Description

_links

_links

name

string

The name of the volume. This field cannot be specified in a 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

A reference to a namespace.

Name Type Description

_links

_links

name

string

The name of an NVMe namespace. An NVMe namespace is located within a volume. Optionally, it can be located within a qtree in a volume.

NVMe namespace names are paths of the form "/vol/<volume>[/<qtree>]/<namespace>" where the qtree name is optional.

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.

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.