NSX-T Data Center REST API

Get information about all tasks

Request:

Method:

GET

URI Path(s):

/policy/api/v1/tasks
/api/v1/tasks

Request Headers:

n/a

Query Parameters:

TaskQueryParameters+

TaskQueryParameters (schema)

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
request_uri	Request URI(s) to include in query result Comma-separated request URIs to include in query result	string
sort_ascending		boolean
sort_by	Field by which records are sorted	string
status	Status(es) to include in query result Comma-separated status values to include in query result	string
user	Names of users to include in query result Comma-separated user names to include in query result	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/tasks

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

TaskListResult+

TaskListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Task property results	array of TaskProperties	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "result_count" : 1, "results" : [ { "start_time" : 1478646470253, "async_response_available" : true, "cancelable" : false, "end_time" : 1478646470344, "progress" : 100, "id" : "59c7d6c8-7d64-4f0e-8af5-0b5e92bc3330", "user" : "admin", "status" : "SUCCESS" } ] }

Required Permissions:

read

Feature:

utilities_tasks

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable