Use CancelDataFlowTask to cancel a pending or executing data flow task - Cloud Parallel File Storage - Alibaba Cloud - Cloud Parallel File Storage

Cancels a data flow batch task or streaming task that is in the Pending or Executing state.

Operation description

Prerequisites

Before you call this operation, create resources in the following order and make sure that the resources at each layer are in the required state:

Create a file system: Call CreateFileSystem to create a CPFS file system.
- State requirement: The file system is in the Running state.
Create a mount target: Call CreateMountTarget to create a mount target.
- State requirement: The mount target is in the Active state.
Create a fileset: Call CreateFileset to create a fileset.
- State requirement: The fileset is created.
Create a data flow: Call CreateDataFlow to create a data flow.
- State requirement: The data flow is in the Running state.
Create a data flow task: Call CreateDataFlowTask to create a data flow task.

Operation description

Only CPFS 2.2.0 and later and CPFS for Lingjun 2.4.0 and later support data flow tasks. You can view the version information on the file system details page in the console.
Only data flow tasks in the Pending state can be canceled.
Canceling a data flow task typically takes 5 to 10 minutes. You can call DescribeDataFlowTasks to query the task execution status.
If a streaming task contains running streaming subtasks, the streaming task cannot be canceled. Otherwise, the InvalidStatus.ResourceMismatch error is returned.

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. CPFS General-purpose: Must start with `cpfs-`, such as cpfs-125487**. CPFS for Lingjun: Must start with `bmcpfs-`, such as 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 this cancel request to check parameter validity and task state without actually canceling the task. Valid values: true: Sends a check request without actually canceling the task. The check items include whether required parameters are specified, the request format, and the task state. If the check fails, the corresponding error is returned. If the check passes, HTTP status code 200 is returned. false (default): Sends a normal request and directly cancels the task after the check passes.	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 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 to ensure idempotence. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may vary for each API 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.	The FileSystemId parameter is not specified.
400	MissingDataFlowId	DataFlowId is mandatory for this action.	The DataFlowId parameter is not specified.
400	MissingTaskId	TaskId is mandatory for this action.	The TaskId parameter is not specified.
403	OperationDenied.ConflictOperation	The operation is denied due to a conflict with an ongoing operation.	The data flow cannot be created because it conflicts with the current file system operation.
403	OperationDenied.DependencyViolation	The operation is denied due to dependancy violation.	The conditions for this operation are not met.
403	OperationDenied.DataFlowNotSupported	The operation is not supported.	The file system does not support data flows.
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.	The specified data flow does not exist.
404	InvalidTaskId.NotFound	The specified task ID does not exist.	The specified data flow TaskId does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.