Skip to main content
REST API reference
A newer release of this product is available.

Retrieves file clone split status of all volumes in the node

PDFs

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/{volumeuuid}
# 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"
    }
  }
}

GET /storage/file/clone/split-status/{volume.uuid}

Introduced In: 9.10

Retrieves file clone split status of all volumes in the node.

  • 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

self_link

pending_splits

integer

Specifies the number of pending file clone split operations in the volume.

svm

svm

unsplit_clone_size

integer

Specifies the space occupied by unsplit file clones in the volume.

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

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
Name Type Description

self

href

_links

Name Type Description

self

href

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

volume

Name Type Description

_links

_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.

  • example: 028baa66-41bd-11e9-81d5-00a0986138f7

  • Introduced in: 9.6

  • x-nullable: true

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.
Close
Try it out

Sign in with your NetApp Cloud Central credentials.

Try this API

Parameters

Headers

Body

Code

Response