Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Get QoS requirement

GET /qos_requirements/{qid}

Returns detailed information about particular QoS requirement.

Example cURL requests

Get detailed information about QoS requirement

curl -X GET -H "X-Auth-Token: $TOKEN" \
"https://$HOST/api/v3/oneprovider/qos-requirements/$QOS_REQ_ID"

{
  "qosRequirementId": "c84f669f9522c46976fee490d80651f0",
  "fileId": "$FILE_ID",
  "qosExpression": "country=FR",
  "replicasNum": 2,
  "status": "fulfilled"
}

Path parameters

Parameter	Type & Description
qid required	string QoS requirement Id (e.g. 'c84f669f9522c46976fee490d80651f0')

Request Examples

Shell

oneprovider-rest-cli getQosRequirement qid=$QOS_REQ_ID

Responses

application/json

200

Information about QoS requirement.

Property	Type & Description
fileId string Id of file that requirement was created for.
expression string Expression used to select storages on which file should be replicated.
replicasNum integer Number of required file replicas.
status string Indicates fulfillment status of QoS requirement. Enum: fulfilledpendingimpossible

Example

application/json

{
  "qosRequirementId": "c84f669f9522c46976fee490d80651f0",
  "fileId": "00000000005CF4706775696423745F772D67686431633765446F4D76546D6F2D67575F3361737A7670486B477A7936587734507265584A7723394A4F355F5F396E4C31623031594576776E667431723230677767776C6B497031394E445F6E3868677873",
  "expression": "country=FR",
  "replicasNum": 2,
  "status": "fulfilled"
}

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

QoS requirement 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."
}