Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Get details of an archive recall

GET /data/{id}/recall/details

If this file is a root of a past or ongoing archive recall, returns its details. Otherwise, returns 404 NOT FOUND error.

Get archive recall details

curl -H "X-Auth-Token: $TOKEN" \
-X GET "https://$PROVIDER_HOST/api/v3/oneprovider/data/$FILE_ID/recall/details"

{
    "archiveId": "$ARCHIVE_ID",
    "datasetId": "$DATASET_ID",
    "startTime": 1643103923417,
    "finishTime": 1643103933417,
    "totalFileCount" : 1,
    "totalByteSize": 65536,
    "lastError": {
        "fileId": "$FILE_ID",
        "reason": {
          "description": "The resource could not be found.",
          "id": "notFound"
        }
    }
}

Path parameters

Parameter	Type & Description
id required	string File Id.

Request Examples

Shell

oneprovider-rest-cli getArchiveRecallDetails id=$FILE_ID

Responses

application/json

200

Archive recall details.

Property

Type & Description

archiveId

string

Id of the archive that is being recalled.

datasetId

string

Id of the dataset from which the archive was created.

startTime

integer

Timestamp in milliseconds (UNIX epoch) when the recall started (null if not started yet).

finishTime

integer

Timestamp in milliseconds (UNIX epoch) when the recall finished (null if not finished yet).

totalFileCount

integer

Number of files in source archive (number of files that is to be copied by recall).

totalByteSize

integer

Number of bytes in source archive (number of bytes that is to be copied by recall).

lastError

object

Information about the last encountered error, or null.

fileId

string

Id of the file for which error occured.

reason

object (ErrorJson)

Object describing an error.

id required

string

String identifying the error type. Does not change between error instances.

description required

string

Human readable error description. May contain information specific to given error instance.

details

object

Details about the error instance. The object schema is specific to each error type.

ctx required

object (ErrorJsonCtx)

Technical information about error.

timestamp required

integer

Timestamp in milliseconds.

serviceReleaseVersion required

string

Release version of a product, for example "25.1".

serviceId required

string

Identifier of a service instance — either Oneprovider Id or "onezone".

serviceDomain required

string

Domain of the service.

serviceBuildVersion required

string

Build version of the service.

service required

string

Short name of service.

Enum:

ozw opw ozp opp

onedataErrorsRevision required

string

Revision of onedata-errors repo, where the error is defined.

module required

string

Module where the error occurred.

line required

integer

Line number in the module where the error occurred.

Example

application/json

{
  "archiveId": "$ARCHIVE_ID",
  "datasetId": "$DATASET_ID",
  "startTime": 1643103923417,
  "finishTimes": 1643103933417,
  "totalFileCount": 1,
  "totalByteSize": 65536,
  "lastError": {
    "fileId": "$FILE_ID",
    "reason": {
      "description": "The resource could not be found.",
      "id": "notFound"
    }
  }
}

400

Invalid request.

Property

Type & Description

error

object (ErrorJson)

Object describing an error.

id required

string

String identifying the error type. Does not change between error instances.

description required

string

Human readable error description. May contain information specific to given error instance.

details

object

Details about the error instance. The object schema is specific to each error type.

ctx required

object (ErrorJsonCtx)

Technical information about error.

timestamp required

integer

Timestamp in milliseconds.

serviceReleaseVersion required

string

Release version of a product, for example "25.1".

serviceId required

string

Identifier of a service instance — either Oneprovider Id or "onezone".

serviceDomain required

string

Domain of the service.

serviceBuildVersion required

string

Build version of the service.

service required

string

Short name of service.

Enum:

ozw opw ozp opp

onedataErrorsRevision required

string

Revision of onedata-errors repo, where the error is defined.

module required

string

Module where the error occurred.

line required

integer

Line number in the module where the error occurred.

Example

application/json

{
  "error": {
    "id": "example",
    "description": "This is an example error.",
    "ctx": {
      "timestamp": 1750762637248,
      "serviceReleaseVersion": "25.1",
      "serviceId": "a7ee2722915b8bf7fb064eb65087cc61ch9357",
      "serviceDomain": "dev-oneprovider-krakow.default.svc.cluster.local",
      "serviceBuildVersion": "231-g8d26f953c3",
      "service": "opw",
      "onedataErrorsRevision": "ca3af8cb",
      "module": "metadata_req",
      "line": 45
    }
  }
}

403

Forbidden request.

Property

Type & Description

error

object (ErrorJson)

Object describing an error.

id required

string

String identifying the error type. Does not change between error instances.

description required

string

Human readable error description. May contain information specific to given error instance.

details

object

Details about the error instance. The object schema is specific to each error type.

ctx required

object (ErrorJsonCtx)

Technical information about error.

timestamp required

integer

Timestamp in milliseconds.

serviceReleaseVersion required

string

Release version of a product, for example "25.1".

serviceId required

string

Identifier of a service instance — either Oneprovider Id or "onezone".

serviceDomain required

string

Domain of the service.

serviceBuildVersion required

string

Build version of the service.

service required

string

Short name of service.

Enum:

ozw opw ozp opp

onedataErrorsRevision required

string

Revision of onedata-errors repo, where the error is defined.

module required

string

Module where the error occurred.

line required

integer

Line number in the module where the error occurred.

Example

application/json

{
  "error": {
    "id": "example",
    "description": "This is an example error.",
    "ctx": {
      "timestamp": 1750762637248,
      "serviceReleaseVersion": "25.1",
      "serviceId": "a7ee2722915b8bf7fb064eb65087cc61ch9357",
      "serviceDomain": "dev-oneprovider-krakow.default.svc.cluster.local",
      "serviceBuildVersion": "231-g8d26f953c3",
      "service": "opw",
      "onedataErrorsRevision": "ca3af8cb",
      "module": "metadata_req",
      "line": 45
    }
  }
}

404

This file is not a root of any archive recall.

Property

Type & Description

error

object (ErrorJson)

Object describing an error.

id required

string

String identifying the error type. Does not change between error instances.

description required

string

Human readable error description. May contain information specific to given error instance.

details

object

Details about the error instance. The object schema is specific to each error type.

ctx required

object (ErrorJsonCtx)

Technical information about error.

timestamp required

integer

Timestamp in milliseconds.

serviceReleaseVersion required

string

Release version of a product, for example "25.1".

serviceId required

string

Identifier of a service instance — either Oneprovider Id or "onezone".

serviceDomain required

string

Domain of the service.

serviceBuildVersion required

string

Build version of the service.

service required

string

Short name of service.

Enum:

ozw opw ozp opp

onedataErrorsRevision required

string

Revision of onedata-errors repo, where the error is defined.

module required

string

Module where the error occurred.

line required

integer

Line number in the module where the error occurred.

Example

application/json

{
  "error": {
    "id": "example",
    "description": "This is an example error.",
    "ctx": {
      "timestamp": 1750762637248,
      "serviceReleaseVersion": "25.1",
      "serviceId": "a7ee2722915b8bf7fb064eb65087cc61ch9357",
      "serviceDomain": "dev-oneprovider-krakow.default.svc.cluster.local",
      "serviceBuildVersion": "231-g8d26f953c3",
      "service": "opw",
      "onedataErrorsRevision": "ca3af8cb",
      "module": "metadata_req",
      "line": 45
    }
  }
}

500

Internal server error.

Property

Type & Description

error

object (ErrorJson)

Object describing an error.

id required

string

String identifying the error type. Does not change between error instances.

description required

string

Human readable error description. May contain information specific to given error instance.

details

object

Details about the error instance. The object schema is specific to each error type.

ctx required

object (ErrorJsonCtx)

Technical information about error.

timestamp required

integer

Timestamp in milliseconds.

serviceReleaseVersion required

string

Release version of a product, for example "25.1".

serviceId required

string

Identifier of a service instance — either Oneprovider Id or "onezone".

serviceDomain required

string

Domain of the service.

serviceBuildVersion required

string

Build version of the service.

service required

string

Short name of service.

Enum:

ozw opw ozp opp

onedataErrorsRevision required

string

Revision of onedata-errors repo, where the error is defined.

module required

string

Module where the error occurred.

line required

integer

Line number in the module where the error occurred.

Example

application/json

{
  "error": {
    "id": "example",
    "description": "This is an example error.",
    "ctx": {
      "timestamp": 1750762637248,
      "serviceReleaseVersion": "25.1",
      "serviceId": "a7ee2722915b8bf7fb064eb65087cc61ch9357",
      "serviceDomain": "dev-oneprovider-krakow.default.svc.cluster.local",
      "serviceBuildVersion": "231-g8d26f953c3",
      "service": "opw",
      "onedataErrorsRevision": "ca3af8cb",
      "module": "metadata_req",
      "line": 45
    }
  }
}