NSX-T Data Center REST API

Cancel a running export task

This operation cancels an export task. Task needs to be in running state.

Request:

Method:

POST

URI Path(s):

/policy/api/v1/infra/settings/firewall/export?action=cancel

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

POST https://<policy-mgr>/policy/api/v1/infra/settings/firewall/export?action=cancel

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ExportTask+

ExportTask (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
async_response_available	True if response for asynchronous request is available	boolean	Readonly
cancelable	True if this task can be canceled	boolean	Readonly
description	Description of the task	string	Readonly
draft_path	Policy path of a draft Policy path of a draft if this is an export task to export draft configuration.	string	Readonly
end_time	The end time of the task in epoch milliseconds	EpochMsTimestamp	Readonly
exported_file	Name of the exported file Name of the exported file generated after completion of export task.	string	Readonly
failure_msg	Reason of the task failure This property holds the reason of the task failure, if any.	string	Readonly
id	Identifier for this task	string	Readonly
message	A message describing the disposition of the task	string	Readonly
progress	Task progress if known, from 0 to 100	integer	Readonly Minimum: 0 Maximum: 100
request_method	HTTP request method	string	Readonly
request_uri	URI of the method invocation that spawned this task	string	Readonly
start_time	The start time of the task in epoch milliseconds	EpochMsTimestamp	Readonly
status	Current status of the task	TaskStatus	Readonly
user	Name of the user who created this task	string	Readonly

Example Response:

{ "id": "export_task", "status": "canceled", "description": "Export of the current firewall configuration.", "exported_file": null, "failure_msg": null, "user": "admin", "start_time": 1587491995996 }

Required Permissions:

read

Feature:

policy_dfw

Additional Errors:

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