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

Retrieve the clone split load of a node

Contributors
PDFs

GET /storage/file/clone/split-loads

Introduced In: 9.10

Retrieves the clone split load of a node.

  • volume file clone split load show

The GET operation can be used to retrieve information about clone split load data. Split load data is the data currently undergoing the split. There is a limit on split load data. This API communicates how much data is undergoing split and how much can still be processed.<br>

# The API:
/api/storage/file/clone/split-loads

# The call:
curl -X GET "https://<mgmt_ip>/api/storage/file/clone/split-loads" -H "accept: application/hal+json"

# The response:
{
"records": [
  {
    "node": {
      "uuid": "158d592f-a829-11eb-a47b-005056bb46d7",
      "name": "node1",
      "_links": {
        "self": {
          "href": "/api/cluster/nodes/158d592f-a829-11eb-a47b-005056bb46d7"
        }
      }
    },
    "load": {
      "maximum": 35184372088832,
      "current": 0,
      "token_reserved": 0,
      "allowable": 35184372088832
    },
    "_links": {
      "self": {
        "href": "/api/storage/file/clone/split-loads/158d592f-a829-11eb-a47b-005056bb46d7"
      }
    }
  },
  {
    "node": {
      "uuid": "9686b8d1-a828-11eb-80d8-005056bbe7b6",
      "name": "node2",
      "_links": {
        "self": {
          "href": "/api/cluster/nodes/9686b8d1-a828-11eb-80d8-005056bbe7b6"
        }
      }
    },
    "load": {
      "maximum": 35184372088832,
      "current": 0,
      "token_reserved": 0,
      "allowable": 35184372088832
    },
    "_links": {
      "self": {
        "href": "/api/storage/file/clone/split-loads/9686b8d1-a828-11eb-80d8-005056bbe7b6"
      }
    }
  }
],
"num_records": 2,
"_links":
  "self": {
    "href": "/api/storage/file/clone/split-loads"
  }
}
}

Learn More

  • [DOC /storage/file/clone]

Parameters

Name Type In Required Description

node.uuid

string

query

False

Filter by node.uuid

node.name

string

query

False

Filter by node.name

load.token_reserved

integer

query

False

Filter by load.token_reserved

load.current

integer

query

False

Filter by load.current

load.maximum

integer

query

False

Filter by load.maximum

load.allowable

integer

query

False

Filter by load.allowable

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.

  • Default value: 1

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.

  • Default value: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

collection_links

num_records

integer

Number of records.

records

array[split_load]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "load": {
      "allowable": 0,
      "current": 0,
      "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

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

next

href

self

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

token_reserved

integer

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

_links

Name Type Description

self

href

node_reference

Name Type Description

_links

_links

name

string

uuid

string

split_load

Name Type Description

_links

self_link

load

load

node

node_reference

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.