Skip to main content
REST API reference

Retrieve application component snapshots

PDFs

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

Introduced In: 9.6

Retrieves snapshots of an application component.

This endpoint is only supported for Maxdata template applications.

Component snapshots are essentially more granular application snapshots. There is no difference beyond the scope of the operation.

Learn more

Parameters

Name Type In Required Description

application.uuid

string

path

True

Application UUID

component.uuid

string

path

True

Application Component UUID

component.name

string

query

False

Filter by Application Component Name

uuid

string

query

False

Filter by uuid

name

string

query

False

Filter by name

consistency_type

string

query

False

Filter by consistency_type

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: 15

  • 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_component_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",
      "component": {
        "_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

Application UUID. Valid in URL

component

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_component_snapshot

Name Type Description

_links

_links

application

application

comment

string

Comment. Valid in POST

component

component

consistency_type

string

Consistency Type. This is for categorization 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

Creation Time

is_partial

boolean

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

name

string

Snapshot name. Valid in POST

svm

svm

uuid

string

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