接口功能介绍
创建数据流动策略
接口约束
1.文件系统必须为可用状态，hpfs协议
2.bucketName、sfsDirectory必须存在，且对象存储桶类型必须是标准存储
3.单文件系统可创建的数据流动策略默认配额为10
4.暂不支持双向数据流动策略开关同时打开，目前仅支持单向流动
5.导出策略中"changed"与"new, changed"的效果相同，均为新增+修改
6.创建数据流动策略时，若开关不是True，则传入的dataType和trigger将被置为空
7.若返回结果中含有resources，表示请求下发完成，正在创建中，具体请以数据流动详情接口查询该数据流动是否创建成功
URI
POST /v4/hpfs/new-dataflow
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池 ID | 81f7728662dd11ec810800155d307d5b | |
| sfsUID | 是 | String | 并行文件唯一id | a2d4b927-9511-5a9b-b1de-cfe55779c1ea | |
| sfsDirectory | 是 | String | 并行文件目录，目录名仅允许数字、字母、下划线、连接符、中文组成，每级目录最大长度为255字节，最大全路径长度为4096字节，如果参数为mydir/、mydir、/mydir或/mydir/，则都视为输入/mydir的目录 | /test01 | |
| bucketName | 是 | String | 对象存储的桶名称 | bucket-test | |
| bucketPrefix | 否 | String | 对象存储桶的前缀 | prefix | |
| autoImport | 是 | Boolean | 是否打开自动导入 | true | |
| autoExport | 是 | Boolean | 是否打开自动导出 | false | |
| importDataType | 否 | String | 导入的数据类型，data/metadata，自动导入开关打开时必填 | metadata | |
| exportDataType | 否 | String | 导出的数据类型，仅支持data，自动导出开关打开时必填 | ||
| importTrigger | 否 | String | 导入的触发条件，仅支持new（创建），多个条件使用英文逗号分开，自动导入开关打开时必填 | new | |
| exportTrigger | 否 | String | 导出的触发条件，支持new（创建）、changed（修改）及其组合，多个条件使用英文逗号分开，自动导出开关打开时必填 | ||
| dataflowDescription | 否 | String | 数据流动策略的描述 | this is the test dataflow strategy |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800 为成功，900 为失败) | 800 | |
| message | String | 响应描述 | SUCCESS | |
| description | String | 响应描述 | 成功 | |
| returnObj | Object | 返回对象 | 参考returnObj | |
| errorCode | String | 业务细分码，为 product.module.code 三段式码 | sfs.dataflow.sfsDirectoryNotExists | |
| error | String | 业务细分码，为product.module.code三段式大驼峰码 | Sfs.Dataflow.SfsDirectoryNotExists |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| regionID | String | 资源所属资源池 ID | 81f7728662dd11ec810800155d307d5b | |
| resources | Array of Objects | 资源明细 | 参考 resources |
表 resources
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| dataflowID | String | 数据流动策略ID | dataflow-uuppQ7DV | |
| sfsUID | String | 数据流动策略所属并行文件ID | a2d4b927-9511-5a9b-b1de-cfe55779c1ea |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"sfsUID": "a2d4b927-9511-5a9b-b1de-cfe55779c1ea",
"sfsDirectory": "/test01",
"bucketName": "bucket-test",
"bucketPrefix": "prefix",
"autoImport": true,
"autoExport": false,
"importDataType": "metadata",
"exportDataType": "data",
"importTrigger": "new",
"exportTrigger": "changed",
"bucketDescription": "this is the test dataflow strategy"
}
响应示例
{
"returnObj": {
"regionID": "81f7728662dd11ec810800155d307d5b",
"resources": [
{
"dataflowID": "dataflow-uuppQ7DV",
"sfsUID": "a2d4b927-9511-5a9b-b1de-cfe55779c1ea"
}
]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
