CancelDataFlowTask - Cloud Parallel File Storage - Alibaba Cloud Documentation Center

Cancels a batch or streaming task that is in the Pending or Execute state.

Operation description

Only Cloud Parallel File Storage (CPFS) V2.2.0 and later and CPFS for Lingjun V2.4.0 and later support this operation. You can view the version information on the file system details page in the console.
You can cancel only the data flow tasks that are in the Pending and Executing states.
It generally takes 5 to 10 minutes to cancel a data flow task. You can query the task execution status by calling the DescribeDataFlowTasks operation.
If a data streaming task contains running subtasks, you cannot cancel the streaming task. Otherwise, an InvalidStatus.ResourceMismatch error message is returned.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
nas:CancelDataFlowTask	delete	*DataFlow `acs:nas:{#regionId}:{#accountId}:filesystem/{#filesystemId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
FileSystemId	string	Yes	The ID of the file system. The IDs of CPFS file systems must start with `cpfs-`. Example: cpfs-125487**. The IDs of CPFS for LINGJUN file systems must start with `bmcpfs-`. Example: bmcpfs-0015**.	cpfs-099394bd928c****
DataFlowId	string	Yes	The ID of the dataflow.	df-194433a5be31****
TaskId	string	Yes	The ID of the dataflow task.	task-38aa8e890f45****
DryRun	boolean	No	Specifies whether to perform only a dry run, without performing the actual request. During the dry run, the system checks whether the request parameters are valid and whether the requested resources are available. The dry run does not cancel the specified dataflow task or incur fees. Valid values: true: performs only a dry run. The system checks the required parameters, request syntax, service limits, and available NAS resources. If the request fails the dry run, an error message is returned. If the request passes the dry run, the HTTP status code 200 is returned. false (default): performs a dry run and sends the request. If the request passes the dry run, the specified dataflow task is canceled.	false
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How do I ensure the idempotence? Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.	123e4567-e89b-12d3-a456-42665544****

Response parameters

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

Examples

Sample success responses

JSONformat

{
  "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.	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-09-05	The Error code has changed	View Change Details