Retrieve file clone split status of all volumes
- PDF of this doc site
Collection of separate PDF docs
Creating your file...
GET /storage/file/clone/split-status/{volume.uuid}
Introduced In: 9.10
Retrieves file clone split status of all volumes in the node.
Related Ontap commands
-
volume file clone split status
Learn More
-
[
DOC /storage/file/clone
]
Retrieves the information of split status.
The GET operation retrieves information about split processes in the volume.<br>
pending-clone-splits
is the number of files for which file clone split is not yet completed.<br>
unsplit-size
is the sum of all sizes, in bytes in the volume that is not split.<br>
# The API: /api/storage/file/clone/split-status/{volume.uuid} # The call: curl -X GET "https://<mgmt_ip>/api/storage/file/clone/split-status/ac559964-57a3-40cf-b5cb-f3cb99151a7d" -H "accept: application/hal+json" # The response: { "volume": { "uuid": "ac559964-57a3-40cf-b5cb-f3cb99151a7d", "name": "vol1", "_links": { "self": { "href": "/api/storage/volumes/ac559964-57a3-40cf-b5cb-f3cb99151a7d" } } }, "svm": { "name": "vs1" }, "pending_splits": 0, "unsplit_clone_size": 0, "_links": { "self": { "href": "/api/storage/file/clone/split-status/ac559964-57a3-40cf-b5cb-f3cb99151a7d" } } }
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
volume.uuid |
string |
path |
True |
Volume Instance UUID |
fields |
array[string] |
query |
False |
Specify the fields to return. |
Response
Status: 200, Ok
Name | Type | Description |
---|---|---|
_links |
||
pending_splits |
integer |
Specifies the number of pending file clone split operations in the volume. |
svm |
SVM, applies only to SVM-scoped objects. |
|
unsplit_clone_size |
integer |
Specifies the space occupied by unsplit file clones in the volume. |
volume |
Example response
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"pending_splits": 0,
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"unsplit_clone_size": 0,
"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 |
self_link
Name | Type | Description |
---|---|---|
self |
_links
Name | Type | Description |
---|---|---|
self |
svm
SVM, applies only to SVM-scoped objects.
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
The name of the SVM. This field cannot be specified in a PATCH method. |
uuid |
string |
The unique identifier of the SVM. This field cannot be specified in a PATCH method. |
volume
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
The name of the volume. This field cannot be specified in a POST or PATCH method. |
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_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. |