All Products
Search
Document Center

Cloud Parallel File Storage:CreateDataFlowSubTask

Last Updated:Dec 11, 2024

Creates a data streaming subtask.

Operation description

  • Only Cloud Parallel File Storage (CPFS) for LINGJUN V2.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 a data streaming subtask in the Executing state.
  • Data streaming tasks are executed asynchronously. You can call the DescribeDataFlowSubTasks operation to query the task execution status.
  • When the type of data flow task is streaming, the running status only indicates that a streaming import or export task can be created. It does not indicate that the import or export task is running.

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.

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:
    • The required resource types are displayed in bold characters.
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
nas:CreateDataFlowSubTaskcreate
*DataFlow
acs:nas:{#regionId}:{#accountId}:filesystem/{#filesystemId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
FileSystemIdstringYes

The ID of the file system.

bmcpfs-370lx1ev9ss27o0****
DataFlowIdstringYes

The ID of the data flow.

df-194433a5be31****
DataFlowTaskIdstringYes

The ID of the data flow task.

Note Only the IDs of data streaming tasks are supported.
task-38aa8e890f45****
DryRunbooleanNo

Specifies whether to perform a dry run.

During the dry run, the system checks whether the request parameters are valid and whether the requested resources are available. During the dry run, no data streaming subtask is created and no fee is incurred.

Valid values:

  • true: performs a dry run. The system checks the required parameters, request syntax, and service limits. 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. No value is returned for the DataFlowSubTaskId parameter.
  • false (default): performs a dry run and sends the request. If the request passes the dry run, a data streaming subtask is created.
false
ClientTokenstringNo

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****
SrcFilePathstringYes

The path of the source file. 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 the file name.
/test/file.png
DstFilePathstringYes

The path of the destination file. 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 the file name.
/mnt/file.png
ConditionobjectNo

The check conditions. The check must be passed after the following conditions are specified.

ModifyTimelongNo

The modification time. The value must be a UNIX timestamp. Unit: ns.

1725897600000000000
SizelongNo

The file size. Unit: bytes.

68

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

A70BEE5D-76D3-49FB-B58F-1F398211A5C3
DataFlowSubTaskIdstring

The ID of the data streaming task.

subTaskId-370kyfmyknxcyzw****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400IllegalCharactersThe parameter contains illegal characters.The parameter contains illegal characters.
400MissingFileSystemIdFileSystemId is mandatory for this action.-
400MissingDataFlowIdDataFlowId is mandatory for this action.-
400InvalidFilesystemVersion.NotSupportThis Api does not support this fileSystem version.This Api does not support this fileSystem version.
403OperationDenied.InvalidStateThe operation is not permitted when the status is processing.The operation is not permitted when the status is processing.
403OperationDenied.DependencyViolationThe operation is denied due to dependancy violation.-
403OperationDenied.DataFlowNotSupportedThe operation is not supported.-
404InvalidParameter.InvalidFormatThe EntryList format is invalid.-
404InvalidParameter.SizeTooLargeThe specified EntryList size exceeds 64 KB.-
404InvalidDataFlow.NotFoundThe specified data flow does not exist.-
404InvalidTaskAction.NotSupportedThe task action is not supported.-
404InvalidTaskAction.PermissionDeniedThe task action is not allowed.-
404InvalidSrcTaskId.NotFoundThe SrcTaskId is not found.-
404InvalidDataType.NotSupportedThe data type is not supported.-
404InvalidSrcTaskId.TaskIdInvalidSource task ID is invalid.-
404InvalidSrcTaskId.TaskIdNotFoundSource task ID is not found.-

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