DescribeDataFlowSubTasks API Overview - Cloud Parallel File Storage - Alibaba Cloud - Cloud Parallel File Storage

Queries the batch subtasks of a data flow.

Operation description

Supported only by CPFS for Lingjun 2.6.0 and later. You can view the version information on the file system details page in the console.

Before you begin

Before you call this operation to query data flow subtasks, you must create resources and start tasks in the following order:

Create a bmcpfs file system: You must create a CPFS for Lingjun file system in the console and wait until its status changes to Running.
Create a data flow rule: Call the CreateDataFlow operation on the file system to establish a data flow channel.
Start a data flow task: Call the CreateDataFlowTask operation to create and start a data flow task. The task status must be Running.
Query the subtask list: Subtasks are automatically generated during the execution of a data flow task. Call the DescribeDataFlowSubTasks operation to query the list of these subtasks.

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

list

*DataFlow

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

None

Request parameters

Parameter	Type	Required	Description	Example
FileSystemId	string	Yes	The ID of the file system. Only CPFS for Lingjun file systems are supported. The ID must start with `bmcpfs-`.	bmcpfs-370lx1ev9ss27o0****
Filters	array<object>	No	The filter keys used to query streaming tasks of a data flow.
	object	No
Key	string	No	The name of the filter key. Valid values: DataFlowIds: filters by data flow ID. DataFlowTaskIds: filters by data flow task ID. DataFlowSubTaskIds: filters by data flow streaming task ID. Status: filters by data flow status. SrcFilePath: filters by source file path. DstFilePath: filters by destination file path. Valid values: Status : Filters by data flow status. DstFilePath : Filters by destination file path. DataFlowSubTaskIds : Filters by data flow streaming task ID. SrcFilePath : Filters by source file path. DataFlowIds : Filters by data flow ID. DataFlowTaskIds : Filters by data flow task ID.	DataFlowSubTaskIds
Value	string	No	The value of the filter key. This parameter does not support wildcards. If Key is set to DataFlowIds, Value is set to a data flow ID or a part of a data flow ID. You can specify one or more data flow IDs. A maximum of 10 data flow IDs can be specified. Example: `df-194433a5be31**` or `df-194433a512a2,df-234533a5be31`. If Key is set to DataFlowTaskIds, Value is set to a data flow task ID or a part of a data flow task ID. You can specify one or more data flow task IDs. A maximum of 10 data flow task IDs can be specified. Example: `task-29ee8e890f45` or `task-29ee8e890f45,task-38ae8e890f45`. If Key is set to DataFlowSubTaskIds, Value is set to a data flow streaming task ID or a part of a data flow streaming task ID. You can specify one or more data flow streaming task IDs. A maximum of 10 data flow streaming task IDs can be specified. Example: `subTaskId-370kyfmyknxcyzw` or `subTaskId-247kyfmyknxcyzw,subTaskId-256kyfmyknxcyzw**`. If Key is set to Status, Value is set to the status of the data flow task. Valid values: EXPIRED, CREATED, RUNNING, COMPLETE, CANCELING, FAILED, and CANCELED. Combined queries are supported. If Key is set to SrcFilePath, Value is set to the source file path. The path can be up to 1,023 characters in length. If Key is set to DstFilePath, Value is set to the destination file path. The path can be up to 1,023 characters in length.	subTaskId-370kyfmyknxcyzw****
NextToken	string	No	The token that is used to retrieve the next page of results when the returned results are truncated. You can use NextToken to initiate another request to retrieve the results after the current truncation point.	iWk0AQAAAAAvY2FzZS8=
MaxResults	integer	No	The maximum number of entries to return for a single request. Valid values: 20 to 100. Default value: 20.	20

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	98696EF0-1607-4E9D-B01D-F20930B6****
NextToken	string	The token that is used to retrieve the next page of results when the returned results are truncated. You can use NextToken to initiate another request to retrieve the results after the current truncation point.	pUJaUwAAAABhdGUyNTk1MQ==
DataFlowSubTask	object
DataFlowSubTask	array<object>	The collection of data flow streaming task information.
	array<object>
FileSystemId	string	The ID of the file system.	bmcpfs-370lx1ev9ss27o0****
DataFlowId	string	The ID of the data flow.	df-194433a5be31****
DataFlowTaskId	string	The ID of the data flow task.	task-38aa8e890f45****
DataFlowSubTaskId	string	The ID of the data flow streaming task.	subTaskId-370kyfmyknxcyzw****
SrcFilePath	string	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	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
Status	string	The current status of the data flow streaming task. Valid values: EXPIRED: The task is terminated. CREATED: The task is created. RUNNING: The task is running. COMPLETE: The task is completed. CANCELING: The task is being canceled. FAILED: The task failed. CANCELED: The task is canceled.	FAILED
Progress	integer	The execution progress of the data flow streaming task. Valid values: 0 to 10000.	10000
CreateTime	string	The time when the streaming task was created. The time follows the ISO 8601 standard in the yyyy-MM-dd HH:mm:ss format.	2024-07-01 19:59:29
StartTime	string	The time when the streaming task started to run. The time follows the ISO 8601 standard in the yyyy-MM-dd HH:mm:ss format.	2024-07-03 10:43:16
EndTime	string	The time when the streaming task ended. The time follows the ISO 8601 standard in the yyyy-MM-dd HH:mm:ss format.	2024-07-04 11:14:22
ErrorMsg	string	The error message returned when the task fails. Note If this field is not returned or is empty, no error message is available.	file does not exist
ProgressStats	object	The progress statistics of the data flow streaming task.
BytesTotal	integer	The amount of data scanned at the source. Unit: bytes.	68
BytesDone	integer	The amount of data for which the data flow is completed, including skipped data. Unit: bytes.	68
ActualBytes	integer	The actual amount of data transferred. Unit: bytes.	68
AverageSpeed	integer	The average data transfer speed. Unit: bytes/s.	34
FileDetail	object	The file details.
ModifyTime	integer	The time when the file was last modified. The value is a UNIX timestamp in nanoseconds.	1725897600000000000
Size	integer	The size of the file. Unit: bytes.	68
Checksum	string	The checksum of the file. Example format: crc64:123456.	crc64:850309505450944****

Examples

Success response

JSON format

{
  "RequestId": "98696EF0-1607-4E9D-B01D-F20930B6****",
  "NextToken": "pUJaUwAAAABhdGUyNTk1MQ==",
  "DataFlowSubTask": {
    "DataFlowSubTask": [
      {
        "FileSystemId": "bmcpfs-370lx1ev9ss27o0****\n",
        "DataFlowId": "df-194433a5be31****\n",
        "DataFlowTaskId": "task-38aa8e890f45****",
        "DataFlowSubTaskId": "subTaskId-370kyfmyknxcyzw****\n",
        "SrcFilePath": "/test/file.png\n",
        "DstFilePath": "/mnt/file.png\n",
        "Status": "FAILED",
        "Progress": 10000,
        "CreateTime": "2024-07-01 19:59:29",
        "StartTime": "2024-07-03 10:43:16",
        "EndTime": "2024-07-04 11:14:22",
        "ErrorMsg": "file does not exist",
        "ProgressStats": {
          "BytesTotal": 68,
          "BytesDone": 68,
          "ActualBytes": 68,
          "AverageSpeed": 34
        },
        "FileDetail": {
          "ModifyTime": 1725897600000000000,
          "Size": 68,
          "Checksum": "crc64:850309505450944****"
        }
      }
    ]
  }
}

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	InvalidFilesystemVersion.NotSupport	This Api does not support this fileSystem version.	This Api does not support this fileSystem version.
403	OperationDenied.DataFlowNotSupported	The operation is not supported.	The file system does not support dataflow.
404	InvalidParameter.InvalidNextToken	The specified NextToken is invaild.
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	InvalidParameter.InvalidMaxResults	The specified MaxResults is invalid.	The specified MaxResults value is invalid.
404	InvalidFilterParam	The specified Filter.N.Key is invalid.	The specified Filter.N.Key parameter is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.