调用DescribeDataFlowTasks接口查询数据流动任务-阿里云帮助中心

接口说明

该接口仅适用于中国站。
仅CPFS 2.2.0及以上版本支持查询数据流动任务。您可以在控制台文件系统详情页面查看版本信息。

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeDataFlowTasks	接口名称。固定取值：DescribeDataFlowTasks。
FileSystemId	String	是	cpfs-099394bd928c****	文件系统ID。
Filters.N.Key	String	否	DataFlowIds	筛选键的名称。取值： DataFlowIds: 根据DataFlow ID筛选。 TaskIds：根据数据流动任务的ID筛选。 Originator：根据数据流动任务的发起者筛选。 TaskActions：根据数据流动任务的类型筛选。 DataTypes：根据数据流动任务的数据类型筛选。 Status：根据数据流动状态筛选。 CreateTimeBegin：筛选指定时间后创建的数据流动任务。 CreateTimeEnd：筛选指定时间前创建的数据流动任务。 StartTimeBegin：筛选指定时间后启动的数据流动任务。 StartTimeEnd：筛选指定时间前启动的数据流动任务。 EndTimeBegin：筛选指定时间后结束的数据流动任务。 EndTimeEnd：筛选指定时间前结束的数据流动任务。
Filters.N.Value	String	否	dfid-12345678	筛选键的值。该参数不支持通配符。 Key取值为DataFlowIds时，Value取值为数据流动ID或数据流动ID的一部分。可以是一个或一组DataFlowId，数据流动ID最多可设置10个。例如，`dfid-12345678`或`dfid-12345678,dfid-12345679`。当Key取值为TaskId时，Value取值为数据流动任务ID或数据流动任务ID的部分。可以是一个或一组数据流动任务ID，数据流动任务ID最多可设置10个。例如，`task-12345678`或`task-12345678,task-12345679`。当Key取值为TaskActions时，Value取值为数据流动的任务类型，包括Impopt，Expopt、Evict和Inventory。支持组合查询。当Key取值为DataTypes时，Value取值为数据流动任务的数据类型，包括MetaAndData、Metadata和Data。支持组合查询。当Key取值为Originator时，Value取值为数据流动任务的发起者，包括User，System。当Key取值为Status时，Value取值为数据流动任务的状态，包括Pending、Executing、Failed、Completed、Canceling和Canceled。支持组合查询。当Key取值为CreateTimeBegin时，Value取值为数据流动任务创建时间最小值。格式为`yyyy-MM-ddThh:mmZ`。当Key取值为CreateTimeEnd时，Value取值为数据流动任务创建时间最大值。格式为`yyyy-MM-ddThh:mmZ`。当Key取值为CreateTimeBegin时，Value取值为数据流动任务启动时间最小值。格式为`yyyy-MM-ddThh:mmZ`。当Key取值为CreateTimeEnd时，Value取值为数据流动任务启动时间最大值。格式为`yyyy-MM-ddThh:mmZ`。当Key取值为CreateTimeBegin时，Value取值为数据流动任务结束时间最小值。格式为`yyyy-MM-ddThh:mmZ`。当Key取值为CreateTimeEnd时，Value取值为数据流动任务结束时间最大值。格式为`yyyy-MM-ddThh:mmZ`。
NextToken	String	否	TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=	当请求的返回结果被截断时，您可以使用NextToken再次发起请求，获取从当前截断位置之后的内容。
MaxResults	Long	否	20	每次查询结果的个数。取值范围：10~100。默认值：20。

返回数据


名称	类型	示例值	描述
RequestId	String	2D69A58F-345C-4FDE-88E4-BF518948****	请求ID。
NextToken	String	TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=	当请求的返回结果被截断时，您可以使用NextToken再次发起请求，获取从当前截断位置之后的内容。
TaskInfo	Array of Task		数据流动任务信息集合。
Task
FilesystemId	String	cpfs-099394bd928c****	文件系统ID。
DataFlowId	String	dfid-194433a5be3****	数据流动ID。
TaskId	String	taskId-12345678	数据流动任务ID。
SourceStorage	String	oss://bucket1	源端存储的访问路径。格式：<storage type>://<path>。其中： storage type：目前只支持OSS。 path：OSS的bucket名称。仅支持小写字母、数字和短划线（-）且必须以小写字母或者数字开头和结尾。长度为8~128个英文字符。使用UTF-8编码。不能以http://和https://开头。说明 OSS Bucket必须为在该地域已存在的Bucket。
FileSystemPath	String	/a/b/c/	Fileset在CPFS文件系统中的路径。限制：长度为2~1024个英文或中文字符。使用UTF-8编码。必须以/开头和结尾。该目录必须是CPFS上的Fileset目录。
Originator	String	User	数据流动任务的发起者。包括： User：用户是该任务的发起者。 System：该任务是自动更新任务，是CPFS根据自动更新间隔时间自动发起的任务。
TaskAction	String	Import	数据流动任务类型。包括： Import：从源端存储将指定的数据导入至CPFS。 Export：将CPFS上指定的数据导出至源端存储。 Evict：释放CPFS上文件的数据块，释放后文件在CPFS上只保留元数据，您仍能查询该文件，但文件数据块已清除，不占用CPFS上的存储容量。当访问该文件数据时，将再从源端存储按需加载。 Inventory：获取CPFS上数据流动管理的文件清单，可提供文件在数据流动中的缓存状态。
DataType	String	Metadata	数据流动任务操作的数据类型。包括： Metadata：文件的元数据，包括文件的timestamp, ownership, permission等属性信息。选择Metadata，只会导入文件的元数据，用户只能看到该文件，但访问该文件数据时，数据从源端存储按需加载。 Data：文件的数据块。 MetaAndData：文件的元数据和数据块。
Progress	Long	240	数据流动任务的进度。当前数据流动任务已经执行的操作数量。
Status	String	Executing	数据流动任务的状态。包括： Pending: 数据流动任务已创建，在排队中未开始执行。 Executing：数据流动任务在执行中。 Failed：数据流动任务执行失败，可以通过查看数据流动任务报告，查看失败原因。 Completed：数据流动任务执行结束，可以通过查看数据流动任务报告，查看所有文件已正确传输。 Canceled：数据流动任务被取消并且没有完成。 Canceling：数据流动任务正在被取消。
ReportPath	String	/path_in_cpfs/reportfile.cvs	数据流动任务报告在CPFS文件系统中保存的路径。任务报告会生成在CPFS的`.dataflow_report`目录中。限制：长度为2~1024个英文字符。使用UTF-8编码。
CreateTime	String	2021-08-04 18:27:35	任务创建时间。
StartTime	String	2021-08-04 18:27:35	任务开始执行时间。
EndTime	String	2021-08-04 18:27:35	任务结束时间。
FsPath	String	/aa/	智能目录路径。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeDataFlowTasks
&FileSystemId=cpfs-099394bd928c****
&Filters=[{"Key":"DataFlowIds","Value":"dfid-12345678"}]
&NextToken=TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
&MaxResults=20
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDataFlowTasksResponse>
    <RequestId>2D69A58F-345C-4FDE-88E4-BF518948****</RequestId>
    <NextToken>TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=</NextToken>
    <TaskInfo>
        <FilesystemId>cpfs-099394bd928c****</FilesystemId>
        <DataFlowId>dfid-194433a5be3****</DataFlowId>
        <TaskId>taskId-12345678</TaskId>
        <SourceStorage>oss://bucket1</SourceStorage>
        <FileSystemPath>/a/b/c/</FileSystemPath>
        <Originator>User</Originator>
        <TaskAction>Import</TaskAction>
        <DataType>Metadata</DataType>
        <Progress>240</Progress>
        <Status>Executing</Status>
        <ReportPath>/path_in_cpfs/reportfile.cvs</ReportPath>
        <CreateTime>2021-08-04 18:27:35</CreateTime>
        <StartTime>2021-08-04 18:27:35</StartTime>
        <EndTime>2021-08-04 18:27:35</EndTime>
        <FsPath>/aa/</FsPath>
    </TaskInfo>
</DescribeDataFlowTasksResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "2D69A58F-345C-4FDE-88E4-BF518948****",
  "NextToken" : "TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=",
  "TaskInfo" : [ {
    "FilesystemId" : "cpfs-099394bd928c****",
    "DataFlowId" : "dfid-194433a5be3****",
    "TaskId" : "taskId-12345678",
    "SourceStorage" : "oss://bucket1",
    "FileSystemPath" : "/a/b/c/",
    "Originator" : "User",
    "TaskAction" : "Import",
    "DataType" : "Metadata",
    "Progress" : 240,
    "Status" : "Executing",
    "ReportPath" : "/path_in_cpfs/reportfile.cvs",
    "CreateTime" : "2021-08-04 18:27:35",
    "StartTime" : "2021-08-04 18:27:35",
    "EndTime" : "2021-08-04 18:27:35",
    "FsPath" : "/aa/"
  } ]
}

错误码


HttpCode	错误码	错误信息	描述
400	IllegalCharacters	The parameter contains illegal characters.	参数非法。
400	MissingFileSystemId	FileSystemId is mandatory for this action.	未指定FileSystemId参数。
403	OperationDenied.DataFlowNotSupported	The operation is not supported.	该文件系统不支持数据流动。
404	InvalidParameter.InvalidNextToken	The specified NextToken is invaild.	指定的NextToken非法。
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参数非法。

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