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

Retrieve a file clone token

Contributors
PDFs

GET /storage/file/clone/tokens/{node.uuid}/{uuid}

Introduced In: 9.10

Retrieves a file clone token

  • volume file clone token show

Retrieve information for single token.

# The call:
curl -X GET "https://<mgmt_ip>/api/storage/file/clone/tokens/97255711-a1ad-11eb-92b2-0050568eb2ca/905c42ce-a74b-11eb-bd86-0050568ec7ae"

# The response:
{
"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": 41943040,
"expiry_time": {
  "limit": "PT1H10M",
  "left": "PT1H9M"
},
"_links": {
  "self": {
    "href": "/api/storage/file/clone/tokens/97255711-a1ad-11eb-92b2-0050568eb2ca/905c42ce-a74b-11eb-bd86-0050568ec7ae"
  }
}
}

Learn More

  • [DOC /storage/file/clone]

Parameters

Name Type In Required Description

node.uuid

string

path

True

Node UUID

uuid

string

path

True

Token UUID

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

self_link

expiry_time

expiry_time

node

node_reference

reserve_size

integer

Specifies the available reserve in the file clone split load for the given token.

uuid

string

Token UUID.

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

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.

_links

Name Type Description

self

href

node_reference

Name Type Description

_links

_links

name

string

uuid

string

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.