接口功能介绍
更新数据流动策略
接口约束
1.文件系统必须为可用状态，hpfs协议
2.数据流动策略状态必须为fail、syncing或available
3.暂不支持双向数据流动策略开关同时打开，目前仅支持单向流动
4.导出策略中"changed"与"new, changed"的效果相同，均为新增+修改
5.autoImport、autoExport不传时，传入对应的dataType和trigger无效
6.autoImport、autoExport为False时，会将对应的dataType和trigger置空
7.若返回结果中含有resources，表示请求下发完成，正在更新中，具体请以数据流动详情接口查询该数据流动是否更新成功
URI
POST /v4/hpfs/update-dataflow
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池 ID | 81f7728662dd11ec810800155d307d5b | |
| dataflowID | 是 | String | 数据流动策略ID | dataflow-j9Kn2B | |
| autoImport | 否 | Boolean | 是否打开自动导入 | true | |
| autoExport | 否 | Boolean | 是否打开自动导出 | false | |
| importDataType | 否 | String | 导入的数据类型，data/metadata，自动导入开关打开时必填 | data | |
| exportDataType | 否 | String | 导出的数据类型，仅支持data，自动导入开关打开时必填 | data | |
| importTrigger | 否 | String | 导入的触发条件，仅支持new（创建），多个条件使用英文逗号分开，自动导出开关打开时必填 | new,changed | |
| 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.invalidSwitch | |
| error | String | 业务细分码，为product.module.code三段式大驼峰码 | Sfs.Dataflow.InvalidSwitch |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| regionID | String | 资源所属资源池 ID | 81f7728662dd11ec810800155d307d5b |
表 errorDetail
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| bssErrCode | String | bss错误明细码，包含于bss格式化JSON错误信息中 | code_foo | |
| bssErrMsg | String | bss错误信息，包含于bss格式化JSON错误信息中 | error_foo | |
| bssOrigErr | String | 无法明确解码bss错误信息时，原样透出的bss错误信息 | unknow_error | |
| bssErrPrefixHint | String | bss格式化JSON错误信息的前置提示信息 | error_bar |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"dataflowID": "dataflow-j9Kn2B",
"autoImport": true,
"autoExport": false,
"importDataType": "data",
"exportDataType": "data",
"importTrigger": "new,changed",
"dataflowDescription": "this is the test dataflow strategy"
}
响应示例
{
"returnObj": {
"regionID": "81f7728662dd11ec810800155d307d5b",
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
