You need to enable JavaScript to run this app.
文档中心
文件存储 vePFS

文件存储 vePFS

复制全文
下载 pdf
数据流动
DescribeDataFlowTasks - 查询数据流动任务
复制全文
下载 pdf
DescribeDataFlowTasks - 查询数据流动任务
调用 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 object[] 示例值:详情请参见返回示例。​
数据流动任务信息。​
Status string 示例值:Canceled​
任务状态,取值说明如下:​
  • Creating:创建中。​
  • Running:运行中。​
  • Finished:已完成。​
  • Canceling:取消中。​
  • Canceled:已取消。​
  • Deleting:删除中。​
  • Error:错误。​
  • Deleted:已删除。​
​
EndTime string 示例值:2025-05-21T20:44:41+08:00​
任务结束时间。​
​
Reports object[] 示例值:详情请参见返回示例。​
任务报告。​
Path string 示例值:https://anser-vepfs-9a5880d6****.tos-cn-guangzhou.volces.com/****​
报告的链接。​
​
Type string 示例值:InventoryFiles​
报告的类型,取值说明如下:​
  • FailedFiles:失败报告。​
  • InventoryFiles:对账报告。​
​
​
SubPath string 示例值:/subpath****/​
Fileset 下的子路径(或者指定文件系统全路径)。​
​
DataType string 示例值:MetaAndData​
数据类型,取值说明如下:​
MetaAndData:元数据和数据。​
​
ExecSize string 示例值:100​
任务已执行容量。​
​
ExecCount string 示例值:100​
完成操作数,对预热沉降任务有效。​
​
FilesetId string 示例值:fset-0a3e****​
Fileset ID。​
​
StartTime string 示例值:2025-05-21T20:32:48+08:00​
任务开始执行时间。​
​
TotalSize string 示例值:1000​
任务总容量。​
​
CreateTime string 示例值:2025-05-21T20:32:48+08:00​
任务创建时间。​
​
QueueCount string 示例值:1000​
加入队列的总操作数,对预热沉降任务有效。​
​
TaskAction string 示例值:Import​
任务类型,取值说明如下:​
  • Import:预热任务。​
  • Export:沉降任务。​
  • Inventory:对账任务。​
​
UpdateTime string 示例值:2025-05-21T20:44:41+08:00​
任务修改时间。​
​
DataStorage string 示例值:tos://buckname​
源端存储(TOS Bucket)名称。​
​
FailedCount string 示例值:0​
加入队列后的失败总数。​
​
FilesetPath string 示例值:/test-dataflow****/​
Fileset 的路径。​
​
FileSystemId string 示例值:vepfs-cnbj4c83fc4a****​
文件系统 ID。​
​
DataFlowTaskId string 示例值:task-cnbj025700c1****​
数据流动任务 ID。​
​
DataStoragePath string 示例值:/bigfiletest****/​
Bucket 路径前缀。​
​
EntryListFileInfo object 示例值:{ "FileKey": "path1/file_list.txt", "FileName": "file_list.txt", "FileBucket": "user-bucket-****" }​
任务执行的列表文件信息。​
FileName string 示例值:file_list.txt​
任务执行的列表文件名称,在使用本地列表文件或用户 TOS 桶中的列表文件进行预热、沉降的时候均需要指定。​
​
FileBucket string 示例值:user-bucket-****​
任务执行的列表文件所在的桶,在使用用户 TOS 桶中的列表文件预热、沉降时需要指定。​
​
FileKey string 示例值:path1/file_list.txt​
任务执行的列表文件标识。​
  • 使用本地列表文件进行预热、沉降时,需要先通过 CreatePreSignedUrl 接口生成临时文件上传链接,CreatePreSignedUrl 接口会返回该值,示例值:210037****/2025-05-21/e88f40fd-5290-409c-9e7d-16e8d36a**** 。​
  • 使用用户 TOS 桶中的列表文件进行预热、沉降时,需要指定为列表文件对应的对象路径,示例值:path1/file_list.txt。​
​
​
SameNameFilePolicy string 示例值:KeepLatest​
同名文件策略,取值说明如下:​
  • Skip:跳过同名文件。​
  • KeepLatest:保持最新文件。​
  • OverWrite:覆盖同名文件。​
​
ExportSymlinkPolicy string 示例值:Skip​
导出任务软链接处理策略,取值说明如下:​
  • Skip:跳过软链接文件。​
  • NormalFile:导出为独立文件。​
​
EntryListFileUrl string 示例值:/​
任务执行的列表文件下载链接。​
​
​
​
​
请求示例​
​
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": "202603061101061851860381942C****",​
"Action": "DescribeDataFlowTasks",​
"Version": "2022-01-01",​
"Service": "vepfs",​
"Region": "cn-beijing"​
},​
"Result": {​
"TotalCount": 1,​
"PageSize": 10,​
"PageNumber": 1,​
"DataFlowTasks": [​
{​
"Status": "Canceled",​
"EndTime": "2025-05-21T20:44:41+08:00",​
"Reports": [​
{​
"Path": "https://anser-vepfs-9a5880d6****.tos-cn-guangzhou.volces.com/****",​
"Type": "InventoryFiles"​
}​
],​
"SubPath": "/subpath****/",​
"DataType": "MetaAndData",​
"ExecSize": "100",​
"ExecCount": "100",​
"FilesetId": "fset-0a3e****",​
"StartTime": "2025-05-21T20:32:48+08:00",​
"TotalSize": "1000",​
"CreateTime": "2025-05-21T20:32:48+08:00",​
"QueueCount": "1000",​
"TaskAction": "Import",​
"UpdateTime": "2025-05-21T20:44:41+08:00",​
"DataStorage": "tos://buckname",​
"FailedCount": "0",​
"FilesetPath": "/test-dataflow****/",​
"FileSystemId": "vepfs-cnbj4c83fc4a****",​
"DataFlowTaskId": "task-cnbj025700c1****",​
"DataStoragePath": "/bigfiletest****/",​
"EntryListFileInfo": {​
"FileName": "file_list.txt",​
"FileBucket": "user-bucket-****",​
"FileKey": "path1/file_list.txt"​
},​
"SameNameFilePolicy": "KeepLatest",​
"ExportSymlinkPolicy": "Skip",​
"EntryListFileUrl": "/"​
}​
]​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
500​
InternalError​
Service has some internal Error. Pls Contact With Admin.​
内部错误。​
​
​
最近更新时间:2026.03.06 11:19:23
这个页面对您有帮助吗?
有用
有用
无用
无用