Skip to main content

Retrieve an application Snapshot copy

Contributors
PDFs

GET /application/applications/{application.uuid}/snapshots

Introduced In: 9.6

Retrieves Snapshot copies of an application.

Query examples

The following query returns all Snapshot copies from May 4, 2017 EST. For readability, the colon (:) is left in this example. For an actual call, they should be escaped as %3A.

GET /application/applications/{application.uuid}/snapshots?create_time=2017-05-04T00:00:00-05:00..2017-05-04T23:59:59-05:00

The following query returns all Snapshot copies that have been flagged as application consistent.

GET /application/applications/{application.uuid}/snapshots?consistency_type=application

Learn more

Parameters

Name Type In Required Description

application.uuid

string

path

True

Application UUID

uuid

string

query

False

Filter by UUID

name

string

query

False

Filter by name

consistency_type

string

query

False

Filter by consistency_type

components.name

string

query

False

Filter by components.name

components.uuid

string

query

False

Filter by components.uuid

comment

string

query

False

Filter by comment

create_time

string

query

False

Filter by create_time

is_partial

string

query

False

Filter by is_partial

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

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

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

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[application_snapshot]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "application": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "string",
        "uuid": "string"
      },
      "comment": "string",
      "components": [
        {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "name": "string",
          "uuid": "string"
        }
      ],
      "consistency_type": "string",
      "create_time": "string",
      "name": "string",
      "svm": {
        "name": "string",
        "uuid": "string"
      },
      "uuid": "string"
    }
  ]
}

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

next

href

self

href

_links

Name Type Description

self

href

application

Name Type Description

_links

_links

name

string

Application name

uuid

string

The application UUID. Valid in URL.

components

Name Type Description

_links

_links

name

string

Component name

uuid

string

Component UUID

svm

Name Type Description

name

string

SVM name

uuid

string

SVM UUID

application_snapshot

Name Type Description

_links

_links

application

application

comment

string

Comment. Valid in POST.

components

array[components]

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

Creation time

is_partial

boolean

A partial Snapshot copy means that not all volumes in an application component were included in the Snapshot copy.

name

string

The Snapshot copy name. Valid in POST.

svm

svm

uuid

string

The Snapshot copy UUID. Valid in URL.

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.