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

Retrieve information for a token

PDFs

GET /storage/file/clone/tokens

Introduced In: 9.10

Retrieves information for the specified token.

  • volume file clone token show

Learn More

  • [DOC /storage/file/clone]

Retrieving information on clone tokens

# The API:
/api/storage/file/clone/tokens

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

# The response:
{
"records": [
  {
    "node": {
      "uuid": "97255711-a1ad-11eb-92b2-0050568eb2ca",
      "name": "node1",
      "_links": {
        "self": {
          "href": "/api/cluster/nodes/97255711-a1ad-11eb-92b2-0050568eb2ca"
        }
      }
    },
    "uuid": "905c42ce-a74b-11eb-bd86-0050568ec7ae",
    "reserve_size": 10240,
    "expiry_time": {
      "limit": "PT1H10M",
    },
    "_links": {
      "self": {
        "href": "/api/storage/file/clone/tokens/97255711-a1ad-11eb-92b2-0050568eb2ca/905c42ce-a74b-11eb-bd86-0050568ec7ae"
      }
    }
  }
],
"num_records": 1,
"_links": {
  "self": {
    "href": "/api/storage/file/clone/tokens"
  }
}
}

Parameters

Name Type In Required Description

node.uuid

string

query

False

Filter by node.uuid

node.name

string

query

False

Filter by node.name

uuid

string

query

False

Filter by uuid

reserve_size

integer

query

False

Filter by reserve_size

expiry_time.left

string

query

False

Filter by expiry_time.left

expiry_time.limit

string

query

False

Filter by expiry_time.limit

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: 15

  • 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[token]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {}
  ]
}

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

next

href

self

href
Name Type Description

self

href

expiry_time

Name Type Description

left

string

Specifies the time remaining before the given token expires in ISO-8601 format.

limit

string

Specifies when the given token expires in ISO-8601 format.

node

Name Type Description

name

string

Node name

uuid

string

Node UUID

token

token

Name Type Description

_links

self_link

expiry_time

expiry_time

node

node

reserve_size

integer

Specifies the available reserve in the file clone split load for the given token. Also note that the minimum value for reserve size is 4KB and any value specified below 4KB will be rounded off to 4KB.

uuid

string

Token UUID.

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.