DescribeDataFlowSubTasks - Cloud Parallel File Storage - Alibaba Cloud Documentation Center

Queries data flow subtasks in batches.

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.

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

Operation	Access level	Resource type	Condition key	Associated operation
nas:DescribeDataFlowSubTasks	list	*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.	bmcpfs-370lx1ev9ss27o0****
Filters	array<object>	No	The filter that is used to query data streaming tasks.
	object	No
Key	string	No	The filter name. Valid values: DataFlowIds: filters data flow subtasks by data flow ID. DataFlowTaskIds: filters data flow subtasks by data flow task ID. DataFlowSubTaskIds: filters data flow subtasks by data streaming task ID. Status: filters data flow subtasks by status. SrcFilePath: filters data flow subtasks by source file path. DstFilePath: filters data flow subtasks by destination file path.	DataFlowSubTaskIds
Value	string	No	The filter value. This parameter does not support wildcards. If Key is set to DataFlowIds, set Value to a data flow ID or a part of the data flow ID. You can specify a data flow ID or a group of data flow IDs. You can specify a maximum of 10 data flow IDs. Example: `df-194433a5be31**` or `df-194433a5be31,df-244433a5be31`. If Key is set to DataFlowTaskIds, set Value to a data flow task ID or a part of the data flow task ID. You can specify a data flow task ID or a group of data flow task IDs. You can specify a maximum of 10 data flow task IDs. Example: `task-38aa8e890f45` or `task-38aa8e890f45,task-27aa8e890f45`. If Key is set to DataFlowSubTaskIds, set Value to a data streaming task ID or a part of the data streaming task ID. You can specify a data streaming task ID or a group of data streaming task IDs. You can specify a maximum of 10 data streaming task IDs. Example: `subTaskId-370kyfmyknxcyzw` or `subTaskId-370kyfmyknxcyzw,subTaskId-280kyfmyknxcyzw**`. If Key is set to Status, set Value to the status of the data flow task. The status can be EXPIRED, CREATED, RUNNING, COMPLETE, CANCELING, FAILED, or CANCELED. Combined query is supported. If Key is set to SrcFilePath, set Value to the path of the source file. The path can be up to 1,023 characters in length. If Key is set to DstFilePath, set Value to the path of the destination file. The path can be up to 1,023 characters in length.	subTaskId-370kyfmyknxcyzw****
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.	iWk0AQAAAAAvY2FzZS8=
MaxResults	long	No	The number of results for each query. Valid values: 20 to 100. Default value: 20.	20

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	98696EF0-1607-4E9D-B01D-F20930B6****
NextToken	string	The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.	pUJaUwAAAABhdGUyNTk1MQ==
DataFlowSubTask	array<object>	The details about data streaming tasks.
DataFlowSubTask	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 streaming task.	subTaskId-370kyfmyknxcyzw****
SrcFilePath	string	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
DstFilePath	string	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
Status	string	The status of the data streaming task. Valid values: EXPIRED: The task is terminated. CREATED: The task is created. RUNNING: The task is running. COMPLETE: The task is complete. CANCELING: The task is being canceled. FAILED: The task failed to be executed. CANCELED: The task is canceled.	COMPLETE
Progress	integer	The progress of the data streaming task. Valid values: 0 to 10000.	10000
CreateTime	string	The time when the data streaming task was created.	2024-07-01 19:59:29
StartTime	string	The time when the data streaming task started.	2024-07-03 10:43:16
EndTime	string	The time when the data streaming task ended.	2024-07-04 11:14:22
ErrorMsg	string	The error message returned when the task failed.	{"ErrorKey":"PATH_NOT_ACCESSIBLE","ErrorDetail":"lstat /cpfs/370lx1ev9ss27o****/test/abcdfnotfound: no such file or directory"}
ProgressStats	object	The progress information about data streaming tasks.
BytesTotal	long	The amount of data scanned on the source. Unit: bytes.	68
BytesDone	long	The amount of data (including skipped data) for which the data flow task is complete. Unit: bytes.	68
ActualBytes	long	The actual amount of data for which the data flow task is complete. Unit: bytes.	68
AverageSpeed	long	The average flow velocity. Unit: bytes/s.	34
FileDetail	object	The file information.
ModifyTime	long	The time when the file was modified. The value is a UNIX timestamp. Unit: ns.	1721167603
Size	long	The file size. Unit: bytes.	68
Checksum	string	The checksum. Format example: crc64:123456.	crc64:850309505450944****

Examples

Sample success responses

JSONformat

{
  "RequestId": "98696EF0-1607-4E9D-B01D-F20930B6****",
  "NextToken": "pUJaUwAAAABhdGUyNTk1MQ==",
  "DataFlowSubTask": {
    "DataFlowSubTask": [
      {
        "FileSystemId": "bmcpfs-370lx1ev9ss27o0****\n",
        "DataFlowId": "df-194433a5be31****",
        "DataFlowTaskId": "task-38aa8e890f45****",
        "DataFlowSubTaskId": "subTaskId-370kyfmyknxcyzw****\n",
        "SrcFilePath": "/test/file.png\n",
        "DstFilePath": "/mnt/file.png\n",
        "Status": "COMPLETE",
        "Progress": 10000,
        "CreateTime": "2024-07-01 19:59:29",
        "StartTime": "2024-07-03 10:43:16",
        "EndTime": "2024-07-04 11:14:22",
        "ErrorMsg": "{\"ErrorKey\":\"PATH_NOT_ACCESSIBLE\",\"ErrorDetail\":\"lstat /cpfs/370lx1ev9ss27o****/test/abcdfnotfound: no such file or directory\"}",
        "ProgressStats": {
          "BytesTotal": 68,
          "BytesDone": 68,
          "ActualBytes": 68,
          "AverageSpeed": 34
        },
        "FileDetail": {
          "ModifyTime": 1721167603,
          "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.	-
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.	-
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.	-
404	InvalidParameter.InvalidMaxResults	The specified MaxResults is invalid.	-
404	InvalidFilterParam	The specified Filter.N.Key is invalid.	-

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

Change history

Change time	Summary of changes	Operation

No change history