Retrieve an application snapshot
GET /application/applications/{application.uuid}/snapshots/{uuid}
Introduced In: 9.6
Retrieve a snapshot 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 |
uuid |
string |
path |
True |
Snapshot UUID |
fields |
array[string] |
query |
False |
Specify the fields to return. |
Response
Status: 200, Ok
Name | Type | Description |
---|---|---|
_links |
||
application |
||
comment |
string |
Comment. Valid in POST. |
components |
array[components] |
|
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 |
Creation time |
is_partial |
boolean |
A partial snapshot means that not all volumes in an application component were included in the snapshot. |
name |
string |
The snapshot name. Valid in POST. |
svm |
||
uuid |
string |
The snapshot UUID. Valid in URL. |
Example response
{
"_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 |
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 |
The application UUID. Valid in URL. |
components
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
Component name |
uuid |
string |
Component UUID |
svm
Name | Type | Description |
---|---|---|
name |
string |
SVM name |
uuid |
string |
SVM UUID |
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. |