金山云-文档中心-查询数据流动任务

1. 接口描述

本接口（DescribeDataFlowTasks）用于查询数据流动任务。

2. 请求方法

GET

3. 请求参数

请求参数包含公共请求参数和接口请求参数。其中，公共请求参数是每个接口都会用到的请求参数，具体参见公共参数及签名机制；接口请求参数是各个接口所特有的，具体参见下方说明：

请求头

名称	是否必须	值
Content-Type	是	application/json
Accept	否	application/json

请求体

名称	类型	是否必须	描述
FileSystemId	string	是	文件系统ID。
DataFlowId	string	否	数据流动ID。
TaskIds	string	否	数据流动任务ID，逗号分割。
PageSize	number	否	分页大小，默认为10。
PageNum	number	否	页码，默认为1。
Action	string	是	该参数为公共参数，取值：DescribeDataFlowTasks。
Version	string	是	该参数为公共参数，取值：2024-09-30。

4. 返回参数

名称	类型	描述
Data	object[]
—FileSystemId	string	KPFS文件系统ID。
—DataFlowId	string	数据流动ID。
—Name	string	数据流动名称。
—DirPath	string	数据流动关联的KPFS文件系统目录完整绝对路径。若返回/，代表整个文件系统。
—Bucket	string	KS3 Bucket名称。
—BucketPrefix	string	KS3 Bucket前缀。若返回空，代表整个存储桶。
—TaskId	string	数据流动任务ID。
—TaskAction	string	数据流动任务类型。当前仅支持import。
—SrcDirectory	string	数据的源目录，为数据流动绑定关系中BucketPrefix下的相对路径。
—DstDirectory	string	数据的目标目录，为数据流动绑定关系中DirPath下的相对路径。
—Bandwidth	string	数据流动任务配置带宽，单位MB/s。
—Status	string	任务的运行状态。 waiting：等待中。 running：运行中。 closed：已关闭。 abnormal：异常中断。 completed：已完成。
—CreateTime	string	任务创建时间。
—StartTime	string	任务开始时间。
—EndTime	string	任务结束时间。
—ExcuteTime	string	任务执行时长，单位s。
—ScanFileCount	number	任务扫描的总文件数。
—CompletedFileCount	number	任务已完成的文件数（包括跳过。遇到同名文件时，在文件大小不一致，并且会比较与源文件的修改时间保留最新版本，将进行覆盖，否则将跳过）。
—FailedFileCount	number	任务失败的文件数。
—ScanFileBytes	number	任务扫描的总文件大小，单位Byte。
—CompletedFileBytes	number	任务已完成的总文件大小（包括跳过。遇到同名文件时，在文件大小不一致，并且会比较与源文件的修改时间保留最新版本，将进行覆盖，否则将跳过），单位Byte。
—TaskIops	number	任务运行的IOPS，为实时进度，单位次/s。
—TaskBandwidth	number	任务运行的带宽，为实时进度，单位Byte/s。
PageSize	number	分页大小。
PageNum	number	页码。
TotalCount	number	数据流动任务总数。
RequestId	string	唯一请求ID，每次请求都会返回。

5. 示例

请求示例

curl --location --request GET 'kpfs.api.ksyun.com/?Action=DescribeDataFlowTasks&Version=2024-09-30&FileSystemId=f81e17eafcfe488bb3dbd33f5bcf8792&DataFlowId=4a6c793587774a4c9c3444d6dbb2a03b&TaskIds=c3d909da25d741709910c012325e3fc7' \
--header 'X-KSC-ACCOUNT-ID: 73404680' \
--header 'X-KSC-API: DescribeDataFlowTasks' \
--header 'X-Amz-Date: 20260209T030143Z' \
--header 'Authorization: AWS4-HMAC-SHA256 Credential=AKLTZ3cTib9eQNm9jQv37smn/20260209/cn-beiing-6/kpfs/aws4_request, SignedHeaders=host;x-amz-date;x-ksc-account-id;x-ksc-api, Signature=540f9ebc52cdf0310b925f97e446886dbb99c81338b3691365c17a5a9f32f147'

返回示例

{
    "RequestId": "d8230314-f1f1-47e6-beea-8bbcb4d6ea11",
    "Data": [
        {
            "DataFlowId": "4a6c793587774a4c9c3444d6dbb2a03b",
            "Name": "dataflow-test-001",
            "FileSystemId": "f81e17eafcfe488bb3dbd33f5bcf8792",
            "DirPath": "/",
            "Bucket": "xlftestimport",
            "BucketPrefix": "",
            "TaskAction": "import",
            "TaskId": "0721e9473687453ebdd4ff1e305170d6",
            "SrcDirectory": "",
            "DstDirectory": "/dir20260206006",
            "Bandwidth": 300,
            "CreateTime": "2026-02-06T18:40:13",
            "Status": "completed",
            "StartTime": "2026-02-06T20:49:51",
            "EndTime": "2026-02-06T23:00:41",
            "ExcuteTime": "7850",
            "ScanFileCount": 247237,
            "CompletedFileCount": 247237,
            "FailedFileCount": 0,
            "ScanFileBytes": 208754103647,
            "CompletedFileBytes": 208754103647,
            "TaskIops": 31,
            "TaskBandwidth": 26592879
        }
    ],
    "PageSize": 10,
    "PageNum": 1,
    "TotalCount": 1
}