DescribeDataFlowSubTasks - 查询数据流动流式子任务列表 - 文件存储 CPFS

查询数据流动批量子任务。

接口说明

仅 CPFS 智算版 2.6.0 及以上版本支持。您可以在控制台文件系统详情页面查看版本信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

nas:DescribeDataFlowSubTasks

list

*DataFlow

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

无

请求参数

名称	类型	必填	描述	示例值
FileSystemId	string	是	文件系统 ID。	bmcpfs-370lx1ev9ss27o0****
Filters	array<object>	否	查询数据流动流式任务的筛选键。
	object	否
Key	string	否	筛选键的名称。取值： DataFlowIds: 根据 DataFlow ID 筛选。 DataFlowTaskIds：根据数据流动任务的 ID 筛选。 DataFlowSubTaskIds：根据数据流动流式任务的 ID 筛选。 Status：根据数据流动状态筛选。 SrcFilePath：根据源目标文件路径筛选。 DstFilePath：根据目标文件路径筛选。枚举值： Status : 根据数据流动状态筛选 DstFilePath : 根据目标文件路径筛选 DataFlowSubTaskIds : 根据数据流动流式任务的 ID 筛选 SrcFilePath : 根据源目标文件路径筛选 DataFlowIds : 根据 DataFlow ID 筛选 DataFlowTaskIds : 根据数据流动任务的 ID 筛选	DataFlowSubTaskIds
Value	string	否	筛选键的值。该参数不支持通配符。 Key 取值为 DataFlowIds 时，Value 取值为数据流动 ID 或数据流动 ID 的一部分。可以是一个或一组 DataFlowId，数据流动 ID 最多可设置 10 个。例如，`df-194433a5be31**`或`df-194433a512a2,df-234533a5be31`。当 Key 取值为 DataFlowTaskIds 时，Value 取值为数据流动任务 ID 或数据流动任务 ID 的部分。可以是一个或一组数据流动任务 ID，数据流动任务 ID 最多可设置 10 个。例如，`task-29ee8e890f45`或`task-29ee8e890f45,task-38ae8e890f45`。当 Key 取值为 DataFlowSubTaskIds 时，Value 取值为数据流动流式任务 ID 或数据流动流式任务 ID 的部分。可以是一个或一组数据流动流式任务 ID，数据流动流式任务 ID 最多可设置 10 个。例如，`subTaskId-370kyfmyknxcyzw` 或`subTaskId-247kyfmyknxcyzw,subTaskId-256kyfmyknxcyzw**`。当 Key 取值为 Status 时，Value 取值为数据流动任务的状态，包括 EXPIRED、CREATED、RUNNING、COMPLETE、CANCELING、FAILED 和 CANCELED。支持组合查询。当 Key 取值为 SrcFilePath 时，Value 取值为源目标文件路径。最长为 1023 个字符。当 Key 取值为 DstFilePath 时，Value 取值为目标文件路径。最长为 1023 个字符。	subTaskId-370kyfmyknxcyzw****
NextToken	string	否	当请求的返回结果被截断时，您可以使用 NextToken 再次发起请求，获取从当前截断位置之后的内容。	iWk0AQAAAAAvY2FzZS8=
MaxResults	integer	否	每次查询结果的个数限制。取值范围：20~100 默认值：20	20

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	98696EF0-1607-4E9D-B01D-F20930B6****
NextToken	string	当请求的返回结果被截断时，您可以使用 NextToken 再次发起请求，获取从当前截断位置之后的内容。	pUJaUwAAAABhdGUyNTk1MQ==
DataFlowSubTask	object
DataFlowSubTask	array<object>	数据流动流式任务信息合集。
	array<object>
FileSystemId	string	文件系统 ID。	bmcpfs-370lx1ev9ss27o0****
DataFlowId	string	数据流动 ID。	df-194433a5be31****
DataFlowTaskId	string	数据流动任务 ID。	task-38aa8e890f45****
DataFlowSubTaskId	string	数据流动流式任务 ID。	subTaskId-370kyfmyknxcyzw****
SrcFilePath	string	源文件路径。限制：长度为 1~1023 个字符。使用 UTF-8 编码。必须以正斜线（/）开头。必须以文件名称结尾。	/test/file.png
DstFilePath	string	目标文件路径。限制：长度为 1~1023 个字符。使用 UTF-8 编码。必须以正斜线（/）开头。必须以文件名称结尾。	/mnt/file.png
Status	string	当前数据流动流式任务状态。包括： EXPIRED：任务已终止。 CREATED：任务已创建完成。 RUNNING：任务正在运行中。 COMPLETE：任务已完成。 CANCELING：任务取消中。 FAILED：任务执行失败。 CANCELED：任务已取消。	FAILED
Progress	integer	数据流动流式任务的执行进度。范围：0~10000。	10000
CreateTime	string	流式任务创建时间。执行 ISO8601 标准表示，返回格式：yyyy-MM-dd HH:mm:ss。	2024-07-01 19:59:29
StartTime	string	流式任务开始执行时间。执行 ISO8601 标准表示，返回格式：yyyy-MM-dd HH:mm:ss。	2024-07-03 10:43:16
EndTime	string	流式任务结束时间。执行 ISO8601 标准表示，返回格式：yyyy-MM-dd HH:mm:ss。	2024-07-04 11:14:22
ErrorMsg	string	任务执行失败消息。说明当该字段未返回或者返回为空时，表示没有错误信息。	file does not exist
ProgressStats	object	数据流动流式进度信息。
BytesTotal	integer	源端扫描到数据量。单位：Byte。	68
BytesDone	integer	已完成数据流动数据量（包括跳过数据）。单位：Byte。	68
ActualBytes	integer	实际流动数据量。单位：Byte。	68
AverageSpeed	integer	平均流动速度。单位：Byte/s。	34
FileDetail	object	文件信息。
ModifyTime	integer	文件修改时间，unix 时间戳。单位：ns。	1725897600000000000
Size	integer	文件大小。单位：Byte。	68
Checksum	string	文件校验码。格式示例：crc64:123456。	crc64:850309505450944****

示例

正常返回示例

JSON格式

{
  "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****"
        }
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	IllegalCharacters	The parameter contains illegal characters.	参数非法。
400	MissingFileSystemId	FileSystemId is mandatory for this action.	未指定FileSystemId参数。
400	InvalidFilesystemVersion.NotSupport	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.	指定的文件系统不存在。
404	InvalidDataFlow.NotFound	The specified data flow does not exist.	指定的数据流动不存在。
404	InvalidParameter.InvalidMaxResults	The specified MaxResults is invalid.	指定的MaxResults非法。
404	InvalidFilterParam	The specified Filter.N.Key is invalid.	指定的Filter.N.Key参数非法。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。