Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Get QoS summary for file or directory

GET /data/{id}/qos_summary

Returns QoS summary for file or directory.
QoS summary contains information about effective QoS, which is calculated by merging QoS requirements defined directly for file or directory with QoS requirements defined for all its ancestors.

To lookup file Id using file path, please use this endpoint.

Example cURL requests

Get file QoS summary

curl -X GET -H "X-Auth-Token: $TOKEN" \
"https://$HOST/api/v3/oneprovider/data/$FILE_ID/qos_summary"

{
  "requirements": [{"$QOS_REQ_ID": "pending"}],
  "status": "pending"
}

Path parameters

Parameter	Type & Description
id required	string Id of the file or directory.

Request Examples

Shell

oneprovider-rest-cli getFileQosSummary id=$FILE_ID

Responses

application/json

200

QoS summary for file or directory.

Property	Type & Description
requirements object Mapping including all QoS requirements (Ids) that influence given file/directory and corresponding information of fulfillment status for this file/directory (fulfilled/pending/impossible).
status string Aggregated status of all QoS requirements for given file or directory. Enum: fulfilledpendingimpossible

Example

application/json

{
  "requirements": {
    "c84f669f9522c46976fee490d80651f0": "pending",
    "22c46976fee490d80651f0c84f669f95": "fulfilled"
  },
  "status": "pending"
}

400

Invalid request.

Property	Type & Description
error string Identifier representing internal error code.
error_description string Detailed error message.

Example

application/json

{
  "error": "invalid_token",
  "error_description": "Provided token could not be validated."
}

403

Forbidden request.

Property	Type & Description
error string Identifier representing internal error code.
error_description string Detailed error message.

Example

application/json

{
  "error": "invalid_token",
  "error_description": "Provided token could not be validated."
}

404

File or directory not found.

Property	Type & Description
error string Identifier representing internal error code.
error_description string Detailed error message.

Example

application/json

{
  "error": "invalid_token",
  "error_description": "Provided token could not be validated."
}

500

Internal server error.

Property	Type & Description
error string Identifier representing internal error code.
error_description string Detailed error message.

Example

application/json

{
  "error": "invalid_token",
  "error_description": "Provided token could not be validated."
}