Retrieve attributes of an ongoing SnapMirror transfer
- PDF of this doc site
Collection of separate PDF docs
Creating your file...
GET /snapmirror/relationships/{relationship.uuid}/transfers/{uuid}
Introduced In: 9.6
Retrieves the attributes of a specific ongoing SnapMirror transfer.
Related ONTAP commands
-
snapmirror show
Example
GET "/api/snapmirror/relationships/293baa53-e63d-11e8-bff1-005056a793dd/transfers/293baa53-e63d-11e8-bff1-005056a793dd"
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
relationship.uuid |
string |
path |
True |
SnapMirror relationship UUID |
uuid |
string |
path |
True |
SnapMirror transfer UUID |
fields |
array[string] |
query |
False |
Specify the fields to return. |
Response
Status: 200, Ok
Name | Type | Description |
---|---|---|
_links |
||
archive_retrieval_priority |
string |
This is supported for transfer of restore relationship only. Priority level at which objects are restored from the archival storage. The value can be high, standard or low. The cloud provider's lowest priority will be used as the default. It is only supported for object store SnapMirror relationships. If the objects were not archived, the property will be ignored. |
bytes_transferred |
integer |
Bytes transferred |
checkpoint_size |
integer |
Amount of data transferred in bytes as recorded in the restart checkpoint. |
end_time |
string |
End time of the transfer. |
error_info |
Error information for the transfer. |
|
files |
array[files] |
This is supported for transfer of restore relationship only. This specifies the list of files or LUNs to be restored. Can contain up to eight files or LUNs. |
last_updated_time |
string |
Last updated time of the bytes transferred in an active transfer. |
network_compression_ratio |
string |
Specifies the compression ratio achieved for the data sent over the wire with network compression enabled. This property is only valid for active transfers. |
on_demand_attrs |
string |
Specifies whether or not an on-demand restore is being carried out. This is only supported for the transfer of restore relationships for entire volumes from the object store. A value for read_write_with_user_data_pull should be provided to start an on-demand restore. A file restore from the object store does not support this option. |
options |
array[options] |
Options for snapmirror transfer. |
relationship |
||
snapshot |
string |
Name of Snapshot copy being transferred. |
snapshot_retention_period |
string |
Specifies the duration for which the Snapshot copy specified in the 'source_snapshot' property is locked in the object store. The retention period value represents a duration and must be specified in the ISO-8601 duration format. The retention period can be in years, months, or days. A period specified for years, months, or days is represented in the ISO-8601 format as "P |
source_snapshot |
string |
Specifies the Snapshot copy on the source to be transferred to the destination. |
source_snapshot_uuid |
string |
Specifies the Snapshot copy UUID on the object store source to be restored to the destination. |
state |
string |
Status of the transfer. Set PATCH state to "aborted" to abort the transfer. Set PATCH state to "hard_aborted" to abort the transfer and discard the restart checkpoint. To find "queued" transfers refer to relationships GET API. |
storage_efficiency_enabled |
boolean |
This is supported for transfer of restore relationship only. Set this property to "false" to turn off storage efficiency for data transferred over the wire and written to the destination. |
throttle |
integer |
Throttle, in KBs per second. This "throttle" overrides the "throttle" set on the SnapMirror relationship or SnapMirror relationship's policy. If neither of these are set, defaults to 0, which is interpreted as unlimited. |
total_duration |
string |
Elapsed transfer time. |
uuid |
string |
Unique identifier of the SnapMirror transfer. |
Example response
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"archive_retrieval_priority": "high",
"bytes_transferred": 0,
"checkpoint_size": 0,
"end_time": "2020-12-02 21:36:19 -0500",
"error_info": {
"code": 6620046,
"message": "Transfer aborted"
},
"files": [
{
"destination_path": "/dirb/file2",
"source_path": "/dira/file1"
}
],
"last_updated_time": "2023-09-15 19:58:39 -0400",
"network_compression_ratio": 61,
"on_demand_attrs": "read_write_with_user_data_pull",
"options": [
{
"overwrite": 1,
"preserve_dedup_savings": 1
}
],
"relationship": {
"destination": {
"cluster": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "cluster1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"consistency_group_volumes": [
{
"name": "volume1",
"uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
}
],
"ipspace": "Default",
"path": "svm1:volume1",
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
},
"uuid": "d2d7ceea-ab52-11e8-855e-00505682a4c7"
},
"snapshot": "string",
"snapshot_retention_period": "P30D",
"source_snapshot": "string",
"source_snapshot_uuid": "string",
"state": "string",
"throttle": 0,
"total_duration": "PT28M41S",
"uuid": "4ea7a442-86d1-11e0-ae1c-123478563412"
}
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 |
error_info
Error information for the transfer.
Name | Type | Description |
---|---|---|
code |
integer |
Error code |
message |
string |
Error message |
files
Specifies a file or LUN consisting of a source_path and an optional destination_path. If not specified, the destination_path is the same as the source_path. File restore is not supported if the source_path or destination_path contains commas in its directory or file name.
Name | Type | Description |
---|---|---|
destination_path |
string |
|
source_path |
string |
options
Name | Type | Description |
---|---|---|
overwrite |
boolean |
Specifies whether or not to overwrite the directory during restore from an object store to a FlexVol volume. This property is only supported for restoring a directory from an object store. Valid values are 'true' or 'false'. This property is not supported for full volume restores from an object store. |
preserve_dedup_savings |
boolean |
Specifies whether or not deduplication savings of a backed up Snapshot copy will be preserved during restore from an object store. This parameter is only supported for |