Recomputations Requests
API Calls for listing existing and creating new recomputation requests
Name | Description | Shortcut |
---|---|---|
GET: List Recomputation Requests | This method can be used to retrieve a list of current Recomputation requests. | Description |
POST: Create a new recomputation request | This method can be used to insert a new recomputation request onto the Compute Engine. | Description |
DELETE: Delete a specific recomputation | This method can be used to delete a specific recomputation. | Description |
POST: change status | This method can be used to change status of a specific recomputation. | Description |
DELETE: Reset status of recomputation | This method can be used to reset status of a specific recomputation. | Description |
[GET]: List Recomputation Requests
This method can be used to retrieve a list of current Recomputation requests.
Input
GET /recomputations
Request headers
x-api-key: shared_key_value
Accept: application/json
Response
Headers: Status: 200 OK
Response body
Json Response
{
"root": [
{
"requester_name": "Arya Stark",
"requester_email": "astark@shadowguild.com",
"reason": "power cuts",
"start_time": "2015-01-10T12:00:00Z",
"end_time": "2015-01-30T23:00:00Z",
"report": "EGI_Critical",
"exclude": [
"Gluster"
],
"status": "running",
"timestamp": "2015-02-01T14:58:40",
"history": [
{
"status": "pending",
"timestamp" : "2015-02-01T14:58:40"
},
{
"status": "approved",
"timestamp" : "2015-02-02T08:58:40"
},
{
"status": "running",
"timestamp" : "2015-02-02T09:10:40"
},
]
}
]
}
[POST]: Create a new recomputation request
This method can be used to insert a new recomputation request onto the Compute Engine.
Input
POST /recomputations
Request headers
x-api-key: shared_key_value
Accept: application/json
Parameters
Type | Description | Required | Default value |
---|---|---|---|
start_time |
UTC time in W3C format | YES | |
end_time |
UTC time in W3C format | YES | |
reason |
Explain the need for a recomputation | YES | |
requester_name |
The name of the person submitting the recomputation | YES | |
requester_email |
The email of the person submitting the recomputation | YES | |
report |
Report for which the recomputation is requested | YES | |
exclude |
Groups to be excluded from recomputation. If more than one group are to be excluded use the parameter as many times as needed within the same API call | NO |
Response
Headers: Status: 201 Created
[DELETE]: Delete a specific recomputation
DELETE /recomputations/{ID}
Request headers
x-api-key: shared_key_value
Accept: application/json
Response
Status 200 OK
[POST]: Change status of recomputation
POST /recomputations/{ID}/status
Request headers
x-api-key: shared_key_value
Accept: application/json
POST body
{
"status" : "approved"
}
Eligible recomputation status values:
- pending
- approved
- rejected
- running
- done
If recomputation status input not in eligible values the api will respond with status code 404
:conflict
Response
Status 200 OK
Response body
Json Response
{
"status": {
"message": "Recomputation status updated successfully to: approved",
"code": "200"
}
}
[DELETE]: Reset status of a specific recomputation
DELETE /recomputations/{ID}/status
Request headers
x-api-key: shared_key_value
Accept: application/json
Response
Status 200 OK
Response body
Json Response
{
"status": {
"message": "Recomputation status reset to: pending",
"code": "200"
}
}