CancelDataFlowTask-阿里云帮助中心

Operation description

Data flow tasks are supported only by CPFS 2.2.0 or later and CPFS for AI Computing 2.4.0 or later. The file system details page in the console displays the version information.
A data flow task can be canceled only if it is in the Pending or Executing state.
Canceling a data flow task typically takes 5 to 10 minutes. Call the DescribeDataFlowTasks operation to query the task execution status.
You cannot cancel a streaming task if it has running streaming subtasks. Otherwise, the system returns an InvalidStatus.ResourceMismatch error.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

nas:CancelDataFlowTask

delete

*DataFlow

acs:nas:{#regionId}:{#accountId}:filesystem/{#filesystemId}

None

Request parameters

Parameter	Type	Required	Description	Example
FileSystemId	string	Yes	The file system ID. For a general-purpose CPFS instance, the ID must start with `cpfs-`, for example, `cpfs-125487**`. For a CPFS for AI Computing instance, the ID must start with `bmcpfs-`, for example, `bmcpfs-0015**`.	cpfs-099394bd928c****
DataFlowId	string	Yes	The data flow ID.	df-194433a5be31****
TaskId	string	Yes	The data flow task ID.	task-38aa8e890f45****
DryRun	boolean	No	Specifies whether to perform a dry run for the request. A dry run checks for parameter validity and resource availability without actually canceling the task or incurring charges. Valid values: `true`: Performs a dry run. The system checks the request for potential issues, including missing parameters, invalid formats, and service limits. If the check fails, the system returns an error message; otherwise, it returns a success code. `false` (default): Sends a normal request. After the request passes the check, the task is canceled.	false
ClientToken	string	No	A client-generated token that you can use to ensure the idempotence of the request. The token must be unique across different requests. The `ClientToken` value must be an ASCII string of 64 characters or less. For more information, see How to ensure idempotence. Note If you do not specify this parameter, the system automatically uses the request ID as the `ClientToken`. The request ID is unique for each request.	123e4567-e89b-12d3-a456-42665544****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	2D69A58F-345C-4FDE-88E4-BF518948****

Examples

Success response

JSON format

{
  "RequestId": "2D69A58F-345C-4FDE-88E4-BF518948****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalCharacters	The parameter contains illegal characters.	The parameter contains illegal characters.
400	MissingFileSystemId	FileSystemId is mandatory for this action.
400	MissingDataFlowId	DataFlowId is mandatory for this action.
400	MissingTaskId	TaskId is mandatory for this action.
403	OperationDenied.ConflictOperation	The operation is denied due to a conflict with an ongoing operation.
403	OperationDenied.DependencyViolation	The operation is denied due to dependancy violation.
403	OperationDenied.DataFlowNotSupported	The operation is not supported.
404	InvalidFileSystem.NotFound	The specified file system does not exist.	The specified file system does not exist.
404	InvalidDataFlow.NotFound	The specified data flow does not exist.
404	InvalidTaskId.NotFound	The specified task ID does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.