Skip to main content
REST API reference

Retrieve the volume file clone split load

PDFs

GET /storage/file/clone/split-loads/{node.uuid}

Introduced In: 9.10

Retrieve the volume file clone split load.

  • volume file clone split load show

Parameters

Name Type In Required Description

node.uuid

string

path

True

Node UUID

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

self_link

load

load

node

node
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "load": {
    "allowable": "4KB",
    "current": 0,
    "maximum": "4KB",
    "token_reserved": 0
  },
  "node": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "node1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  }
}

Error

Status: Default, Error
Name Type Description

error

returned_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

load

Name Type Description

allowable

integer

Specifies the available file clone split load on the node.

current

integer

Specifies the current on-going file clone split load on the node.

maximum

integer

Specifies the maximum allowable file clone split load on the node at any point in time. The least allowable file clone split load is 4KB and the maximum is 675TB. The default value is 4KB for the maximum split load when unit is not specified. The default file clone split load is set based on the system configuration.

token_reserved

integer

Specifies the file clone split load on the node reserved for tokens.

_links

Name Type Description

self

href

node

Name Type Description

_links

_links

name

string

uuid

string

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.