Get background task result
Returns result of an asynchronous operation, e.g. database service configuration.
Path parameters
| Parameter | Type & Description |
|---|---|
| id required | string The requested task Id. |
Request Examples
onepanel-rest-cli -u onepanel:$PASSPHRASE getTaskStatus id=$TASK_ID --host https://$PANEL_HOST:9443Responses
The requested task status.
The operation status.
The list of operation steps that have been executed successfully.
Total number of steps to be executed.
error The generic error model for REST requests.
The generic error model for REST requests.
error required Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"status": "running",
"steps": [
"configuring"
],
"totalSteps": 3
}Unauthorized request.
Forbidden request.
The task does not exist.
Internal server error.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}