REST API reference
Create an application component Snapshot copy
Suggest changes
PDFs
POST /application/applications/{application.uuid}/components/{component.uuid}/snapshots
Creates a Snapshot copy of an application component.
This endpoint is only supported for Maxdata template applications.
Required properties
-
name
Recommended optional properties
-
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 |
Request Body
| Name | Type | Description |
|---|---|---|
_links |
||
application |
||
comment |
string |
Comment. Valid in POST |
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 |
||
uuid |
string |
Snapshot 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 |
Example response
{
"job": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"uuid": "string"
}
}Error
Status: Default, Error| Name | Type | Description |
|---|---|---|
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 |
application
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
Application Name |
uuid |
string |
Application UUID. Valid in URL |
component
| Name | Type | Description |
|---|---|---|
_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 |
||
application |
||
comment |
string |
Comment. Valid in POST |
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 |
||
uuid |
string |
Snapshot UUID. Valid in URL |
job_link
| Name | Type | Description |
|---|---|---|
_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. |