NSX-T Data Center REST API

List appliance management tasks

Request:

Method:

GET

URI Path(s):

/api/v1/transport-nodes/{transport-node-id}/node/tasks
/api/v1/cluster/{cluster-node-id}/node/tasks
/api/v1/node/tasks

Request Headers:

n/a

Query Parameters:

ApplianceManagementTaskQueryParameters+

ApplianceManagementTaskQueryParameters (schema)

Name	Description	Type	Notes
fields	Fields to include in query results Comma-separated field names to include in query result	string
request_method	Request method(s) to include in query result Comma-separated request methods to include in query result	string	Pattern: "^(=|!=|~|!~)?.+$"
request_path	Request URI path(s) to include in query result Comma-separated request paths to include in query result	string	Pattern: "^(=|!=|~|!~)?.+$"
request_uri	Request URI(s) to include in query result Comma-separated request URIs to include in query result	string	Pattern: "^(=|!=|~|!~)?.+$"
status	Status(es) to include in query result Comma-separated status values to include in query result	string	Pattern: "^(=|!=|~|!~)?.+$"
user	Names of users to include in query result Comma-separated user names to include in query result	string	Pattern: "^(=|!=|~|!~)?.+$"

Request Body:

n/a

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ApplianceManagementTaskListResult+

ApplianceManagementTaskListResult (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 ApplianceManagementTaskProperties	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Required Permissions:

read

Feature:

system_information

Additional Errors:

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