金山云-文档中心-创建数据流动任务

1. 接口描述

本接口（CreateDataFlowTask）用于为某个数据流动绑定关系创建一个数据流动任务。

2. 请求方法

POST

3. 请求参数

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

请求头

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

请求体

名称	类型	是否必须	描述
DataFlowId	string	是	数据流动ID。
TaskAction	string	是	数据流动任务类型，当前仅支持import。 import：将KS3 Bucket的BucketPrefix下数据导入至KPFS DirPath下。
SrcDirectory	string	否	数据的源目录，为数据流动绑定关系中BucketPrefix下的相对路径。 1~1023个字符，不能包含"@"、“..”"@base@"和"@style@"，必须以/开头，不允许以/结尾。
DstDirectory	string	否	数据的目标目录，为数据流动绑定关系中DirPath下的相对路径。必须以/开头，不允许以/结尾。 KPFS文件系统子目录要求必须存在。
EntryList	string[]	否	数据流动任务执行源目录下的文件清单，一个元素代表一个文件名称，限制单次调用最多64KB，采用JSON格式。若文件清单内存在源目录下不存在的文件，迁移时会忽略。任务要同步的源数据为：BucketPrefix+SrcDirectory+EntryList 任务同步到目标的数据路径为：DirPath+DstDirectory+EntryList
Bandwidth	int	否	数据流动任务带宽上限。带宽：MB/s，默认300MB/s。取值范围：300-1500MB/s。
Action	string	是	该参数为公共参数，取值：CreateDataFlowTask。
Version	string	是	该参数为公共参数，取值：2024-09-30。

4. 返回参数

名称	类型	描述
TaskId	string	数据流动任务ID。
RequestId	string	唯一请求ID，每次请求都会返回。

5. 示例

请求示例

curl --location --request POST 'kpfs.api.ksyun.com/?Action=CreateDataFlowTask&Version=2024-09-30' \
--header 'X-KSC-ACCOUNT-ID: 2000074729' \
--header 'X-KSC-API: CreateDataFlowTask' \
--header 'Content-Type: application/json' \
--header 'X-Amz-Content-Sha256: beaead3198f7da1e70d03ab969765e0821b24fc913697e929e726aeaebf0eba3' \
--header 'X-Amz-Date: 20260209T022237Z' \
--header 'Authorization: AWS4-HMAC-SHA256 Credential=AKLTZ3cTib9eQNm9jQv37smn/20260209/cn-beiing-6/kpfs/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-content-sha256;x-amz-date;x-ksc-account-id;x-ksc-api, Signature=92ab504ce6d4e8289ee6503a9f6f4f1fcc3e172f62f0c9633a943f4bc90727ce' \
--data '{
  "DataFlowId": "4a6c793587774a4c9c3444d6dbb2a03b",
  "TaskAction": "import",
  "SrcDirectory": "",
  "DstDirectory": "test0207005"
}'

返回示例

{
    "RequestId": "80425558-e9ef-407e-adc7-d5347995c126",
    "TaskId": "c3d909da25d741709910c012325e3fc7"
}