DescribeDataFlowTasks - 列举数据流动任务--文件存储 vePFS-火山引擎

文档中心

立即注册

导航

DescribeDataFlowTasks - 列举数据流动任务

最近更新时间：2025.05.26 18:00:49首次发布时间：2025.05.26 11:42:50

调用 DescribeDataFlowTasks 接口列举数据流动任务信息。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeDataFlowTasks	要执行的操作，取值：DescribeDataFlowTasks。
Version	String	是	2022-01-01	API的版本，取值：2022-01-01。
PageSize	Integer	否	1	每个分页包含的数据流动任务个数。
PageNumber	Integer	否	10	任务列表的分页页码。
DataFlowTaskIds	String	否	task-cnbj025700c1****	任务 ID 列表。支持按照任务 ID 精确筛选，支持多选，多选时使用英文逗号（,）分隔。
Status	String	否	Running	数据流动任务状态列表。支持多选，多选时使用英文逗号（,）分隔。
TaskAction	String	否	Import	任务类型，取值说明如下： Import：预热任务。 Export：沉降任务。 Inventory：对账任务。
FileSystemId	String	是	vepfs-cnbj4c83fc4a****	文件系统 ID，支持按照任务 ID 精确筛选，支持多选，多选时使用英文逗号（,）分隔。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
TotalCount	Integer	1	数据流动任务个数。
PageSize	Integer	10	每个分页包含的数据流动任务个数。
PageNumber	Integer	1	数据流动任务列表的分页页码。
DataFlowTasks	Array of Object	详情请参见返回示例	数据流动任务信息。

请求示例

POST /?Action=DescribeDataFlowTasks&Version=2022-01-01 HTTP/1.1
Host: vepfs.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250522T031426Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250522/cn-beijing/vepfs/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "FileSystemId": "vepfs-cnbja5e83f61****"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250522111443085083022122D3B668",
    "Action": "DescribeDataFlowTasks",
    "Version": "2022-01-01",
    "Service": "vepfs",
    "Region": "cn-beijing"
  },
  "Result": {
    "DataFlowTasks": [
      {
        "CreateTime": "2025-05-21T21:23:14+08:00",
        "DataFlowTaskId": "task-cnbj345262c8****",
        "DataStorage": "autotest-dataflow-****",
        "DataType": "MetaAndData",
        "DestinationPrefix": "/test/",
        "EndTime": "2025-05-21T22:06:33+08:00",
        "ExecCount": "1719263",
        "ExecSize": "247325704292",
        "ExportSymlinkPolicy": "Skip",
        "FailedCount": "0",
        "FileSystemId": "vepfs-cnbja5e83f61****",
        "Id": "task-cnbi345262c8****",
        "QueueCount": "1719263",
        "SameNameFilePolicy": "KeepLatest",
        "SourceStorage": "autotest-dataflow-****",
        "StartTime": "2025-05-21T21:23:14+08:00",
        "Status": "Finished",
        "SubPath": "/test/",
        "TaskAction": "Import",
        "TotalSize": "247325704292",
        "UpdateTime": "2025-05-21T22:06:33+08:00"
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 1
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
500	InternalError	Service has some internal Error. Pls Contact With Admin.	内部错误。