Skip to main content
A newer release of this product is available.

Create an application component Snapshot copy

Contributors
PDFs

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

Introduced In: 9.6

Creates a Snapshot copy of an application component.

This endpoint is only supported for Maxdata template applications.

Required properties

  • name

  • consistency_type - Track whether this snapshot is application or crash consistent. Component Snapshot copies are essentially more granular application Snapshot copies. 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

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When doing a POST, PATCH, or DELETE operation on a single record, the default is 0 seconds. This means that if an asynchronous operation is started, the server immediately returns HTTP code 202 (Accepted) along with a link to the job. If a non-zero value is specified for POST, PATCH, or DELETE operations, ONTAP waits that length of time to see if the job completes so it can return something other than 202.

  • Default value: 1

  • Max value: 120

  • Min value: 0

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

Request Body

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

Snapshot copy name. Valid in POST

svm

svm

uuid

string

Snapshot copy UUID. Valid in URL
Example request 
{
  "_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"
}

Response

Status: 202, Accepted
Name Type Description

job

job_link
Example response 
{
  "job": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "uuid": "string"
  }
}

Error

Status: Default, Error
Name Type Description

error

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

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

Snapshot copy name. Valid in POST

svm

svm

uuid

string

Snapshot copy UUID. Valid in URL
Name Type Description

_links

_links

uuid

string

The UUID of the asynchronous job that is triggered by a POST, PATCH, or DELETE operation.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

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.