Import Flow¶
从本地任务流文件导入任务流,任务流以指定的名称保存在指定的目录下。
前提条件¶
用户必须属于目标任务流所属的OU。
请求格式¶
POST https://{apigw-address}/batch-processing-service/v2.1/flows
请求参数(URI)¶
名称 | 位置(Path/Query) | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|---|
userId | Query | 必需 | String | 用户ID。如何获取userId信息>> |
orgId | Query | 必需 | String | 用户所属的组织ID。如何获取orgId信息>> |
action | Query | 必需 | String | 固定值:import |
请求参数(Body)¶
名称 | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|
flowId | 可选 | Integer | 任务流ID(如果指定了flowId且指定的flowId不存在,则以指定的flowId作为导入的任务流ID;如果未指定flowId或指定的flowId已存在,则忽略该参数,生成新的flowId)。 |
flowName | 必需 | String | 任务流名称。 |
desc | 可选 | String | 任务流描述信息。 |
dirId | 必需 | String | 任务流所在目录的目录ID(可通过 List Workflow Directories 接口获取)。 |
flowJson | 必需 | List<JSONObject> | 包含任务流的详细信息。详见 Flow结构体 |
错误码¶
代码 | 错误信息 | 描述 |
---|---|---|
62102 | 可显示为以下错误信息:
|
参数不正确 |
62109 | Workflow creating failed | 服务器异常,任务流创建失败 |
有关其他错误码的描述,参见 通用错误码。
示例¶
请求示例¶
url: https://{apigw-address}/batch-processing-service/v2.1/flows?action=import&userId={}&orgId={}
method: POST
requestBody:
{
"flowName": "outuser",
"desc": "",
"dirId": "dirId",
"flowJson": {
"cycle": "D",
"cron": "0 0 0 * * ? *",
"parameters": "[{\"key\":\"REPLACE\",\"value\":\"lili1\"}]",
"submitter": "yourSubmitter",
"owners": "yourOwners",
"visitors": "yourVisitors",
"type": 1,
"desc": "",
"tasks": [
{
"name": "tass",
"resource": "default",
"type": "DATA_INTEGRATION",
"cmd": "echo "hello"",
"submitter": "yourSubmitter",
"filePackage": "",
"cron": "",
"priorityLevel": 0,
"timeout": 300,
"retryLimit": 3,
"retryInterval": 0,
"successCode": "0",
"waitCode": "",
"asLink": true,
"runMode": "{\"taskMode\":1,\"cpu\":0.5,\"memory\":1,\"maxParallel\":0,\"keyType\":0,\"datasourceId\":0,\"path\":\"\",\"content\":\"\"}",
"syncType": 1
}
],
"relations": [],
"startTime": "2019-11-22",
"flowLinks": [],
"syncType": 1,
"linkRelations": [],
"alertMode": 3,
"taskLinks": []
}
}
返回示例¶
{
"code": 0,
"msg": "OK",
"data": {
"flowId": 2839
}
}