Developer Documentation
List Tasks
Released in v6.7.1Returns information about at most 1000 visible (subject to permission checks) tasks matching the Tasks.FilterSpec. All tasks must be in the same provider.
Request
URLURL
https://{api_host}/rest/cis/tasks
Query Parameters
Query Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
TasksFilterSpec | Specification of matching tasks. This is currently required. In the future, if it is unset, the behavior is equivalent to a Tasks.FilterSpec with all fields unset which means all tasks match the filter. |
| optional |
|
TasksGetSpec | Specification of what to return for a task. If unset, the behavior is equivalent to a Tasks.GetSpec with all fields unset which means only the data describe in Info will be returned and the result of the operation will be return. |
Response
Response
Response BodyResponse Body
200 OK returns
ListResponseBody
of type application/json
This structure was autogenerated to hold a response body. It contains: Map of task identifier to information about the task. The key in the result map will be an identifier for the resource type: com.vmware.cis.task.
{
"value": {
"key": {
"cancelable": false,
"end_time": "string",
"error": "string",
"operation": "string",
"parent": "string",
"progress": {
"completed": 0,
"total": 0
},
"service": "string",
"start_time": "string",
"status": "enum",
"user": "string"
}
}
}| Property Name | Type | Description |
|---|---|---|
| value | map of TaskInfo |
Map of task identifier to information about the task. The key in the result map will be an identifier for the resource type: com.vmware.cis.task. |
Errors
| Code | Returns | Description |
|---|---|---|
| 400 | Error | com.vmware.vapi.std.errors.invalid_argument : if any of the specified parameters are invalid. |
| 401 | Error | com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. | com.vmware.vapi.std.errors.unauthorized : if the user doesn't have the required privileges. |
| 404 | Error | com.vmware.vapi.std.errors.resource_inaccessible : if a task's state cannot be accessed or over 1000 tasks matching the Tasks.FilterSpec. |
| 503 | Error | com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request. |
| default | Error | Not available |
