Retrieve the file clone split status of all volumes in the node
Retrieves the split status of file clones for all volumes in the node to monitor ongoing clone operations and manage storage resources effectively.
HTTP method and endpoint
GET /storage/file/clone/split-status
Introduced in
ONTAP 9.10
Usage notes
Retrieves file clone split status of all volumes in the node.
Learn More
-
[
DOC /storage/file/clone]
# The API:
/api/storage/file/clone/split-status
# The call:
curl -X GET "https://<mgmt_ip>/api/storage/file/clone/split-status" -H "accept: application/hal+json"
# The response:
{
"records": [
{
"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"
}
}
},
{
"volume": {
"uuid": "32d95d48-d8b7-11eb-a41d-005056bb3837",
"name": "vs1_root",
"_links": {
"self": {
"href": "/api/storage/volumes/32d95d48-d8b7-11eb-a41d-005056bb3837"
}
}
},
"svm": {
"name": "vs1"
},
"pending_splits": 0,
"unsplit_clone_size": 0,
"_links": {
"self": {
"href": "/api/storage/file/clone/split-status/32d95d48-d8b7-11eb-a41d-005056bb3837"
}
}
}
],
"num_records": 2,
"_links": {
"self": {
"href": "/api/storage/file/clone/split-status"
}
}
}
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
pending_splits |
integer |
query |
False |
Filter by pending_splits |
volume.name |
string |
query |
False |
Filter by volume.name |
volume.uuid |
string |
query |
False |
Filter by volume.uuid |
svm.uuid |
string |
query |
False |
Filter by svm.uuid |
svm.name |
string |
query |
False |
Filter by svm.name |
unsplit_clone_size |
integer |
query |
False |
Filter by unsplit_clone_size |
fields |
array[string] |
query |
False |
Specify the fields to return. |
max_records |
integer |
query |
False |
Limit the number of records returned. |
return_records |
boolean |
query |
False |
The default is true for GET calls. When set to false, only the number of records is returned.
|
return_timeout |
integer |
query |
False |
The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.
|
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
Response
Status: 200, Ok
| Name | Type | Description |
|---|---|---|
_links |
||
num_records |
integer |
Number of Records |
records |
array[split_status] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"records": [
{
"_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 |
collection_links
| Name | Type | Description |
|---|---|---|
next |
||
self |
self_link
| Name | Type | Description |
|---|---|---|
self |
_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.
|
split_status
| Name | Type | Description |
|---|---|---|
_links |
||
pending_splits |
integer |
Specifies the number of pending file clone split operations in the volume. |
svm |
||
unsplit_clone_size |
integer |
Specifies the space occupied by unsplit file clones in the volume. |
volume |
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. |