Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Get transfer status

GET /transfers/{tid}

Returns status of specific transfer.

This operation requires space_view_transfers privilege.

Example cURL requests

Get status of specific transfer

curl -H "X-Auth-Token: $TOKEN" -X GET "https://$PROVIDER_HOST/api/v3/oneprovider/transfers/$TRANSFER_ID"

{
    "type": "replication",
    "userId": "admin",
    "rerunId": null,
    "effectiveJobTransferId": $TRANSFER_ID,
    "spaceId": "6ec1a5413b6f4e2b01a5c85a8fd797e2",
    "dataSourceType": "file",
    "fileId": "00000000005CF4706775696423745F772D67686431633765446F4D76546D6F2D67575F3361737A7670486B477A7936587734507265584A7723394A4F355F5F396E4C31623031594576776E667431723230677767776C6B497031394E445F6E3868677873",
    "filePath": "/space/tmp",
    "transferStatus": "completed",
    "effectiveJobStatus": "completed",
    "replicationStatus": "completed",
    "evictionStatus": "skipped",
    "replicatingProviderId": "HICATChd8wzbFmB6qfGby9VN7MfdXgI1qC4pULGVm8Q",
    "evictingProviderId": null,
    "callback": null,
    "filesToProcess": 1,
    "filesProcessed": 1,
    "filesReplicated": 1,
    "filesEvicted": 0,
    "filesFailed": 0,
    "bytesReplicated": 10485760000,
    "scheduleTime": 1504688800,
    "startTime": 15046888765,
    "finishTime": 1504688814,
    "lastUpdate": 1504988814,
    "minHist": {
        "ASDxicvuisodr78w979879wer": [419430400, 1153433600, 1258291200, 1468006400, 1048576000, 1048576000, 1048576000, 1153433600, 629145600, 1258291200, 0, 0, 0, 0, 0, 0, 0, 0, 0]
    },
    "hrHist": {
        "ASDxicvuisodr78w979879wer": [10485760000, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
    },
    "dyHist": {
        "ASDxicvuisodr78w979879wer": [10485760000, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
    },
    "mthHist": {
        "ASDxicvuisodr78w979879wer": [10485760000, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
    }
}

Path parameters

Parameter Type & Description
tid required
string

Transfer Id.

Request Examples

Shell
oneprovider-rest-cli getTransferStatus tid=$TRANSFER_ID

Responses

application/json
200

Transfer status.

Property
Type & Description
type
string

Requested type of transfer.

Enum:
replication eviction migration
userId
string

Id of the user that started the transfer.

rerunId
string

If the transfer was rerun, this field contains the Id of the new transfer, otherwise null.

effectiveJobTransferId
string

Last transfer Id in chain made of rerunId.

spaceId
string

Id of space in context of which transfer was performed.

dataSourceType
string

Indicates the method of determining files to be transferred.

type = "file" - this transfer covers a single file or a whole directory (recursively). When scheduling such transfer, the user must have permissions to access the file/directory.

type = "view" - this transfer covers files that are returned as a result of querying chosen view. The view must be defined on all providers involved in the process and querying it must return a valid list of file ids to be transferred. For more information about views, please see here.

Enum:
file view
fileId
string

Id of the transferred file or directory.

filePath
string

Path to the file or directory in the virtual file system.

viewName
string

Name of the view that was queried to obtain the list of files to transfer.

queryViewParams
object (QueryViewParams)

View query attributes as provided by Couchbase
descending
boolean

Return the documents in descending order (by key).

key
string

Return only documents that match the specified key. Key must be specified as a JSON value.

limit
integer

Limit the number of the returned documents to the specified number.

skip
integer

Skip this number of records before starting to return the results.

startkey
string

Return records with a value equal to or greater than the specified key. Key must be specified as a JSON value.

startkey_docid
string

Return records starting with the specified document Id.

endkey
string

Stop returning records when the specified key is reached. Key must be specified as a JSON value.

endkey_docid
string

Stop returning records when the specified document Id is reached.

inclusive_end
boolean

Specifies whether the specified end key is included in the result. Note: Do not use inclusive_end with key or keys.

stale
string

Allow records from a stale view to be used. Allowed values are ok, update_after or false.

Enum:
ok update_after false
bbox
string

Specify the bounding box for a spatial query (e.g. bbox=-180,-90,0,0)

spatial
boolean

Enable spatial type of query. When querying the file-popularity view, the start_range and end_range constraints should be specified as 6-dimensional arrays, with the following fields: [SizeLowerLimit, LastOpenHoursEpochLowerLimit, TotalOpenLowerLimit, HoursOpenAvgLowerLimit, DayOpenAvgLowerLimit, MonthOpenAvgLowerLimit].

start_range
string

Array specifying the range in spatial queries (e.g. start_range=[1,0,0,0,0,0]).

end_range
string

Array specifying the range in spatial queries (e.g. end_range=[null,null,null,null,null,null]).

transferStatus
string

Overall status of transfer.

Enum:
scheduled enqueued skipped replicating evicting completed aborting cancelled failed
effectiveJobStatus
string

Overall status of effective transfer job (the last one in chain made of rerunId).

Enum:
scheduled enqueued skipped replicating evicting completed aborting cancelled failed
replicationStatus
string

The status of transfer replication phase.

Enum:
scheduled enqueued skipped active completed aborting cancelled failed
evictionStatus
string

The status of transfer eviction phase.

Enum:
scheduled enqueued skipped active completed aborting cancelled failed
replicatingProviderId
string

Id of provider to which data was copied, ensuring that the provider has a complete replica at the end of the process.

evictingProviderId
string

Id of provider from which replica(s) were removed.

callback
string

Optional callback URL, which will be invoked on transfer completion.

filesToProcess
integer

Total number of files in this transfer.

filesProcessed
integer

Number of files already processed.

filesReplicated
integer

Number of files already replicated.

filesEvicted
integer

Number of files already evicted.

filesFailed
integer

Number of files for which eviction or replication has failed.

bytesReplicated
integer

Number of bytes already replicated.

scheduleTime
integer

Schedule time in seconds (POSIX epoch timestamp).

startTime
integer

Start time in seconds (POSIX epoch timestamp).

finishTime
integer

Finish time in seconds (POSIX epoch timestamp).

lastUpdate
integer

Last transfer update time in seconds (POSIX epoch timestamp).

minHist
object

Replication statistics within the last minute, per provider.

hrHist
object

Replication statistics within the last hour, per provider.

dyHist
object

Replication statistics within the last day, per provider.

mthHist
object

Replication statistics within the last month, per provider.

Example

application/json
{
  "type": "replication",
  "userId": "admin",
  "rerunId": null,
  "effectiveJobTransferId": "c4798eb2dbd2486fae940e6fa0a5071d",
  "spaceId": "6ec1a5413b6f4e2b01a5c85a8fd797e2",
  "dataSourceType": "file",
  "fileId": "00000000005CF4706775696423745F772D67686431633765446F4D76546D6F2D67575F3361737A7670486B477A7936587734507265584A7723394A4F355F5F396E4C31623031594576776E667431723230677767776C6B497031394E445F6E3868677873",
  "filePath": "/My Space 1/Dir2/file3.txt",
  "transferStatus": "completed",
  "effectiveJobStatus": "completed",
  "replicationStatus": "completed",
  "evictionStatus": "skipped",
  "replicatingProviderId": "HICATChd8wzbFmB6qfGby9VN7MfdXgI1qC4pULGVm8Q",
  "evictingProviderId": null,
  "callback": null,
  "filesToProcess": 1,
  "filesProcessed": 1,
  "filesReplicated": 1,
  "filesEvicted": 0,
  "filesFailed": 0,
  "bytesReplicated": 10485760000,
  "scheduleTime": 1504688800,
  "startTime": 15046888765,
  "finishTime": 1504688814,
  "lastUpdate": 1504988814,
  "minHist": {
    "ASDxicvuisodr78w979879wer": [
      419430400,
      1153433600,
      1258291200,
      1468006400,
      1048576000,
      1048576000,
      1048576000,
      1153433600,
      629145600,
      1258291200,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0
    ]
  },
  "hrHist": {
    "ASDxicvuisodr78w979879wer": [
      10485760000,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0
    ]
  },
  "dyHist": {
    "ASDxicvuisodr78w979879wer": [
      10485760000,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0
    ]
  },
  "mthHist": {
    "ASDxicvuisodr78w979879wer": [
      10485760000,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0,
      0
    ]
  }
}
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

Transfer with provided Id was not found.

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
    }
  }
}