创建任务
1. 接口参数
Path:
/api/v1/create_task/wf
method:
post
Request params:
| 参数名称 | 类型 | 必须 | 描述 |
|---|---|---|---|
is_test_task |
bool | 否 | 默认为False;如果传参为True,则认定为此任务为流程测试,不触发真实的接口请求,用于项目流程测试。 |
api_name |
string | 是 | api的名称,在申请wfAPI时的名称,可填写任意值,但请注意,为保证是测试api,此参数内必须包含test,例如:wfapi_test。 |
api_id |
string | 是 | api的id,申请wf的测试环境的api下发的id,请注意!必须为测试环境的api!!! |
api_secret_key |
string | 是 | api的secret_key,申请wf的测试环境的api下发的secret_key,请注意!必须为测试环境!!! |
2. 接口返回
如果成功创建了接口权限开通任务,则会返回以下返回:
{
"code": 200,
"message": "任务已提交,预计40分钟内完成,请稍后携带task_id访问进度;如需强制停止任务,请访问文档:强制停止任务接口",
'task_id':'test-001'
}
3. 注意事项
3.1 项目测试环境开启
如需测试接口,请直接在参数is_test_task中传入True,即可进入测试环境接口,其他的参数可传任意值
3.2 可强行停止期限
任务创建后会被放入任务队列,等待celery消费者领取,在任务被消费者领取后,依旧有10min等待期,等待期与任务执行期中,可随时调用停止任务接口,强行对还未开始或已经开始的任务进行中断,但请注意,一旦任务开始执行,只有任务执行到下个节点,才会被停止,也就是说,任务可能不会立即停止,详见停止任务接口。
3.3 速率限制
同一api_id会加速率限制锁,在10min内,重复请求会返回429,即:
{
"code": 429,
"message": "当前api任务已经在处理中,请勿重新提交,重复请求等待时长为10分钟",
'task_id':'test-001'
}
3.4 任务id
任务返回任务id,后续一系列请求均需要任务id,此id不会重发,为UUID且全局唯一,如丢失,后续一切资源均会丢失,请妥善保管
3.5 密钥加密
代码采用国密4算法对密钥进行加密存入数据库,无须担心测试api泄露,但仍建议调取完成本项目后,进行密钥轮换以杜绝密钥泄露风险。