Create Dataflow Subtasks via CreateDataFlowSubTask API - CPFS - Alibaba Cloud - Cloud Parallel File Storage

Creates a subtask for a data flow streaming task.

Operation description

Before you begin

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

Create a file system: Create a CPFS for Lingjun file system in the console.
- State requirement: The file system is in the Running state.
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 streaming import (StreamImport) or streaming export (StreamExport) task.
- State requirement: The data flow task is in the Executing state.

Operation description

Only CPFS for Lingjun 2.6.0 and later support this operation. You can view the version information on the file system details page in the console.
You can create subtasks only for data flow streaming tasks that are in the Executing state.
Data flow streaming tasks are executed asynchronously. You can call DescribeDataFlowSubTasks to query the execution status of a streaming task.
When the data flow task type is a streaming task, the Executing state only indicates that you can create streaming import or streaming export tasks. It does not indicate that the import or export task is running.

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:CreateDataFlowSubTask

create

*DataFlow

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

None

Request parameters

Parameter	Type	Required	Description	Example
FileSystemId	string	Yes	The file system ID.	bmcpfs-370lx1ev9ss27o0****
DataFlowId	string	Yes	The data flow ID.	df-194433a5be31****
DataFlowTaskId	string	Yes	The data flow task ID. Note Only data flow streaming task IDs are supported.	task-38aa8e890f45****
DryRun	boolean	No	Specifies whether to perform a dry run for this request. A dry run checks parameter validity and resource availability without actually creating an instance or incurring fees. Valid values: true: Sends a check request without creating the data flow. The check items include whether required parameters are specified, the request format, and business limit dependencies. If the check fails, the corresponding error is returned. If the check passes, HTTP status code 200 is returned, but DataFlowSubTaskId is empty. false (default): Sends a normal request. After the check passes, the instance is directly created.	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****
SrcFilePath	string	Yes	The source file path. Limits: The path must be 1 to 1,023 characters in length. The path must be encoded in UTF-8. The path must start with a forward slash (/). The path must end with a file name.	/test/file.png
DstFilePath	string	Yes	The destination file path. Limits: The path must be 1 to 1,023 characters in length. The path must be encoded in UTF-8. The path must start with a forward slash (/). The path must end with a file name.	/mnt/file.png
Condition	object	No	The verification condition. The specified conditions must pass verification.
ModifyTime	integer	No	The modification time as a UNIX timestamp. Unit: ns.	1725897600000000000
Size	integer	No	The file size. Unit: bytes.	68

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	A70BEE5D-76D3-49FB-B58F-1F398211A5C3
DataFlowSubTaskId	string	The data flow streaming task ID.	subTaskId-370kyfmyknxcyzw****

Examples

Success response

JSON format

{
  "RequestId": "A70BEE5D-76D3-49FB-B58F-1F398211A5C3",
  "DataFlowSubTaskId": "subTaskId-370kyfmyknxcyzw****"
}

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	InvalidFilesystemVersion.NotSupport	This Api does not support this fileSystem version.	This Api does not support this fileSystem version.
403	OperationDenied.InvalidState	The operation is not permitted when the status is processing.	The operation is not permitted when the status is processing.
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 dataflow.
404	InvalidParameter.InvalidFormat	The EntryList format is invalid.	The format of the specified EntryList does not meet the requirements.
404	InvalidParameter.SizeTooLarge	The specified EntryList size exceeds 64 KB.	The size of the specified EntryList exceeds 64 KB.
404	InvalidDataFlow.NotFound	The specified data flow does not exist.	The specified dataflow does not exist.
404	InvalidTaskAction.NotSupported	The task action is not supported.	The specified task type is not supported.
404	InvalidTaskAction.PermissionDenied	The task action is not allowed.	The specified task type is not allowed, such as system replication.
404	InvalidSrcTaskId.NotFound	The SrcTaskId is not found.	The specified SrcTaskId does not exist.
404	InvalidDataType.NotSupported	The data type is not supported.	The specified data type is not supported.
404	InvalidSrcTaskId.TaskIdInvalid	Source task ID is invalid.	The specified task ID to be copied is invalid.
404	InvalidSrcTaskId.TaskIdNotFound	Source task ID is not found.	The specified task ID to be copied does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.