全部产品
Search

搜索本产品

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

    文档中心

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

    更新时间：Nov 07, 2024

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

    接口说明

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

    调试

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

    授权信息

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

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    nas:DescribeDataFlowSubTaskslist
    • DataFlow
      acs:nas:{#regionId}:{#accountId}:filesystem/{#filesystemId}
      无
    		无

    请求参数

    名称类型必填描述示例值
    FileSystemIdstring是

    文件系统 ID。

    		bmcpfs-370lx1ev9ss27o0****
    Filtersarray<object>否

    查询数据流动流式任务的筛选键。

    object否
    Keystring否

    筛选键的名称。

    取值：

    • DataFlowIds: 根据 DataFlow ID 筛选。
    • DataFlowTaskIds：根据数据流动任务的 ID 筛选。
    • DataFlowSubTaskIds：根据数据流动流式任务的 ID 筛选。
    • Status：根据数据流动状态筛选。
    • SrcFilePath：根据源目标文件路径筛选。
    • DstFilePath：根据目标文件路径筛选。
    		DataFlowSubTaskIds
    Valuestring否

    筛选键的值。该参数不支持通配符。

    • 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****
    NextTokenstring否

    当请求的返回结果被截断时，您可以使用 NextToken 再次发起请求，获取从当前截断位置之后的内容。

    		iWk0AQAAAAAvY2FzZS8=
    MaxResultslong否

    每次查询结果的个数限制。

    • 取值范围：20~100

    • 默认值：20

    		20

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    		98696EF0-1607-4E9D-B01D-F20930B6****
    NextTokenstring

    当请求的返回结果被截断时，您可以使用 NextToken 再次发起请求，获取从当前截断位置之后的内容。

    		pUJaUwAAAABhdGUyNTk1MQ==
    DataFlowSubTaskarray<object>

    数据流动流式任务信息合集。

    DataFlowSubTaskobject
    FileSystemIdstring

    文件系统 ID。

    		bmcpfs-370lx1ev9ss27o0****
    DataFlowIdstring

    数据流动 ID。

    		df-194433a5be31****
    DataFlowTaskIdstring

    数据流动任务 ID。

    		task-38aa8e890f45****
    DataFlowSubTaskIdstring

    数据流动流式任务 ID。

    		subTaskId-370kyfmyknxcyzw****
    SrcFilePathstring

    源文件路径。 限制：

    • 长度为 1~1023 个字符。
    • 使用 UTF-8 编码。
    • 必须以正斜线（/）开头。
    • 必须以文件名称结尾。
    		/test/file.png
    DstFilePathstring

    目标文件路径。 限制：

    • 长度为 1~1023 个字符。
    • 使用 UTF-8 编码。
    • 必须以正斜线（/）开头。
    • 必须以文件名称结尾。
    		/mnt/file.png
    Statusstring

    当前数据流动流式任务状态。包括：

    • EXPIRED：任务已终止。
    • CREATED：任务已创建完成。
    • RUNNING：任务正在运行中。
    • COMPLETE：任务已完成。
    • CANCELING：任务取消中。
    • FAILED：任务执行失败。
    • CANCELED：任务已取消。
    		FAILED
    Progressinteger

    数据流动流式任务的执行进度。范围：0~10000。

    		10000
    CreateTimestring

    流式任务创建时间。

    		2024-07-01 19:59:29
    StartTimestring

    流式任务开始执行时间。

    		2024-07-03 10:43:16
    EndTimestring

    流式任务结束时间。

    		2024-07-04 11:14:22
    ErrorMsgstring

    任务执行失败消息。

    说明 当该字段未返回或者返回为空时，表示没有错误信息。
    		file does not exist
    ProgressStatsobject

    数据流动流式进度信息。

    BytesTotallong

    源端扫描到数据量。单位：Byte。

    		68
    BytesDonelong

    已完成数据流动数据量（包括跳过数据）。单位：Byte。

    		68
    ActualByteslong

    实际流动数据量。单位：Byte。

    		68
    AverageSpeedlong

    平均流动速度。单位：Byte/s。

    		34
    FileDetailobject

    文件信息。

    ModifyTimelong

    文件修改时间，unix 时间戳。单位：ns。

    		1725897600000000000
    Sizelong

    文件大小。单位：Byte。

    		68
    Checksumstring

    文件校验码。格式示例：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错误码错误信息描述
    400IllegalCharactersThe parameter contains illegal characters.参数非法。
    400MissingFileSystemIdFileSystemId is mandatory for this action.未指定FileSystemId参数。
    400InvalidFilesystemVersion.NotSupportThis Api does not support this fileSystem version.当前接口不支持该版本文件系统。
    403OperationDenied.DataFlowNotSupportedThe operation is not supported.该文件系统不支持数据流动。
    404InvalidParameter.InvalidNextTokenThe specified NextToken is invaild.-
    404InvalidFileSystem.NotFoundThe specified file system does not exist.指定的文件系统不存在。
    404InvalidDataFlow.NotFoundThe specified data flow does not exist.指定的数据流动不存在。
    404InvalidParameter.InvalidMaxResultsThe specified MaxResults is invalid.指定的MaxResults非法。
    404InvalidFilterParamThe specified Filter.N.Key is invalid.指定的Filter.N.Key参数非法。

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史