REST API reference
Check the status of an active file move operation
Suggest changes
PDFs
GET /storage/file/moves/{node.uuid}/{uuid}/{index}
Introduced In: 9.12
Overview
Retrieve the status of an on-going file move operation.
Related ONTAP commands
-
volume file move show -
volume rebalance file-move show
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
node.uuid |
string |
path |
True |
Unique identifier of the node. |
uuid |
string |
path |
True |
Unique identifier of the file move operation. |
index |
integer |
path |
True |
The index of the file move within the overall operation |
fields |
array[string] |
query |
False |
Specify the fields to return. |
Response
Status: 200, Ok| Name | Type | Description |
|---|---|---|
cutover_time |
integer |
Time that the file move operation takes before cutover completes, in seconds. |
destination |
Destination file information. |
|
elapsed_time |
integer |
Time elapsed since the start of the file move operation, in seconds. |
failure |
Contains the most recent failure reason for move operation. |
|
files_to_move |
A list of source files along with the destination file they are moved to. If the terminal path component of the destination is a directory, then the source file's basename is replicated in that directory. This is only used for FlexVol volume file move operations. |
|
index |
integer |
An additional unique element identifying one file among many that could possibly be moved as part of a job. File index is an identifier ordered by the file path arrays provided during create. For file move operations that involve only one file, the file-index value of zero is always correct. |
is_destination_ready |
boolean |
Indicates whether the destination file is ready for use. |
is_flexgroup |
boolean |
Indicates whether this is a FlexGroup file move operation. |
is_snapshot_fenced |
boolean |
Indicates whether Snapshot copies are fenced. |
max_cutover_time |
integer |
The maximum amount of time, in seconds that the source can be quiesced before a destination file must be made available for read-write traffic. Not supported in FlexGroup volume file move operations. |
max_throughput |
integer |
Maximum amount of data, in bytes that can be transferred per second in support of this operation. A non-zero value less than 1 MB/s is set to 1 MB/s. A non-zero value greater than 1 MB/s is truncated to the nearest integral megabyte value. If unspecified, the default value is "0" which means no range is set for the data transfer. |
node |
Node hosting the destination of this move operation. |
|
reference |
Reference file information. |
|
scanner |
||
source |
Source file information. |
|
svm |
SVM of the FlexGroup volume in file move operation. Only used in a FlexGroup volume file move operation. |
|
uuid |
string |
The UUID which uniquely identifies the job that started this move operation. |
volume |
FlexGroup volume in file move operation. Only used in a FlexGroup volume file move operation. |
Example response
{
"cutover_time": 8,
"destination": {
"path": "d1/d2/file1",
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"volume": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "volume1",
"uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
}
},
"elapsed_time": 100,
"failure": {
"arguments": {
"code": "string",
"message": "string"
},
"code": "4",
"message": "entry doesn't exist",
"target": "uuid"
},
"files_to_move": {
"destinations": {
"path": "d1/d2/file1",
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"volume": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "volume1",
"uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
}
},
"sources": {
"path": "d1/d2/file1",
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"volume": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "volume1",
"uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
}
}
},
"index": 0,
"max_cutover_time": 10,
"max_throughput": 250000,
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"reference": {
"max_cutover_time": 5,
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"volume": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "volume1",
"uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
}
},
"scanner": {
"percent": 80,
"progress": 80000,
"state": "allocation_map",
"total": 100000
},
"source": {
"path": "d1/d2/file1",
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"volume": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "volume1",
"uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
}
},
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"uuid": "4fcb3159-a4ee-42b5-bb16-f752f2c430fc",
"volume": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "volume1",
"uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
}
}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 |
svm
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
The name of the SVM. |
uuid |
string |
The unique identifier of the SVM. |
volume
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
The name of the volume. |
uuid |
string |
Unique identifier for the volume. This corresponds to the instance-uuid that is exposed in the CLI and ONTAPI. It does not change due to a volume move.
|
destination
Destination file information.
| Name | Type | Description |
|---|---|---|
path |
string |
|
svm |
||
volume |
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
error
Contains the most recent failure reason for move operation.
| 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. |
destinations
| Name | Type | Description |
|---|---|---|
path |
string |
|
svm |
||
volume |
sources
| Name | Type | Description |
|---|---|---|
path |
string |
|
svm |
||
volume |
files_to_move
A list of source files along with the destination file they are moved to. If the terminal path component of the destination is a directory, then the source file's basename is replicated in that directory. This is only used for FlexVol volume file move operations.
| Name | Type | Description |
|---|---|---|
destinations |
array[destinations] |
The destination file information. |
sources |
array[sources] |
The source file information. |
node
Node hosting the destination of this move operation.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
uuid |
string |
svm
SVM of the source reference file.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
The name of the SVM. |
uuid |
string |
The unique identifier of the SVM. |
volume
Volume of the source reference file.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
The name of the volume. |
uuid |
string |
Unique identifier for the volume. This corresponds to the instance-uuid that is exposed in the CLI and ONTAPI. It does not change due to a volume move.
|
reference
Reference file information.
| Name | Type | Description |
|---|---|---|
max_cutover_time |
integer |
The maximum amount of time, in seconds that the source reference file can be quiesced before the corresponding destination file must be made available for read-write traffic. Not supported in FlexGroup volume file move operations. |
path |
string |
The source reference file. If a reference file is specified, data for other files being moved will be transferred as a difference from the reference file. This can save bandwidth and destination storage if the specified source files share blocks. If provided, this input must match one of the source file paths. This input need not be provided if only one source file is specified. Not supported in FlexGroup volume file move operations. |
svm |
SVM of the source reference file. |
|
volume |
Volume of the source reference file. |
scanner
| Name | Type | Description |
|---|---|---|
percent |
integer |
Scanner progress, as a percentage. |
progress |
integer |
Scanner progress, in bytes scanned. |
state |
string |
Status of the file move scanner. |
total |
integer |
Total bytes to be scanned. |
source
Source file information.
| Name | Type | Description |
|---|---|---|
path |
string |
|
svm |
||
volume |
svm
SVM of the FlexGroup volume in file move operation. Only used in a FlexGroup volume file move operation.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
The name of the SVM. |
uuid |
string |
The unique identifier of the SVM. |
volume
FlexGroup volume in file move operation. Only used in a FlexGroup volume file move operation.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
The name of the volume. |
uuid |
string |
Unique identifier for the volume. This corresponds to the instance-uuid that is exposed in the CLI and ONTAPI. It does not change due to a volume move.
|
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. |