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

1. 接口描述

本接口（CreateDataFlow）用于创建一个KPFS文件系统与KS3对象存储的数据流动绑定关系。

2. 请求方法

POST

3. 请求参数

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

请求头

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

请求体

名称	类型	是否必须	描述
Name	string	是	数据流动名称，最大64字符。
FileSystemId	string	是	KPFS文件系统ID。
DirPath	string	否	KPFS文件系统目录完整绝对路径。若不设置，默认/，代表整个文件系统。必须以/开头，不允许以/结尾。 KPFS文件系统目录要求必须存在。 KPFS文件系统目录不能与其它数据流动规则存在重复。
Bucket	string	是	KS3 Bucket名称，必须与KPFS实例在相同地域，3~63个字符，只能包含小写字母、数字和连字符（-），且不能以连字符（-）开头或结尾。
BucketPrefix	string	否	KS3 Bucket前缀。若不设置，代表整个存储桶。 1~1023个字符，不能包含"@"、“..”"@base@"和"@style@"。 KS3存储桶前缀不能与其它数据流动规则存在重复。
Description	string	否	描述信息。
Action	string	是	该参数为公共参数，取值：CreateDataFlow。
Version	string	是	该参数为公共参数，取值：2024-09-30。

4. 返回参数

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

5. 示例

请求示例

curl --location --request POST 'kpfs.api.ksyun.com/?Action=CreateDataFlow&Version=2024-09-30' \
--header 'X-KSC-ACCOUNT-ID: 2000074729}' \
--header 'X-KSC-API: CreateDataFlow' \
--header 'Content-Type: application/json' \
--header 'X-Amz-Content-Sha256: beaead3198f7da1e70d03ab969765e0821b24fc913697e929e726aeaebf0eba3' \
--header 'X-Amz-Date: 20260209T025605Z' \
--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=c8fac7d0e3bc4e9ea46c9ce422353ebcf4c6ab5997dfb0bdb7bc0a36d01e1404' \
--data '{
  "Name": "xlfdataflow2",
  "FileSystemId": "a147273ca6094062969cd297f3c039ed",
  "DirPath": "",
  "Bucket": "xlftestimport",   
  "BucketPrefix":"",
  "Description":"xlf test xlfdataflow2"
}'

返回示例

{
    "RequestId": "21757716-9b06-4d97-a7d7-a448d9330197",
    "DataFlowId": "ac3066d367ea43fa92fd75843b283b7c"
}