更新时间:2022-07-13 GMT+08:00
分享

启动管道作业

功能介绍

提交管道作业到运行环境,实时接收数据源的数据并按用户定义的数据清洗逻辑对数据进行处理。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v1/{project_id}/pipelines/{pipeline_id}/start

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

最小长度:1

最大长度:128

pipeline_id

String

管道ID

最小长度:1

最大长度:100

表2 Query参数

参数

是否必选

参数类型

描述

parallel

Integer

运行管道的并发度

最小值:0

最大值:1000

rtu

Integer

运行管道的RTU个数

最小值:2

最大值:3

resume_savepoint

Boolean

运行管道作业使用历史缓存数据

缺省值:false

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

租户Token

最小长度:1

最大长度:65535

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

pipeline_id

String

管道ID

最小长度:1

最大长度:100

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:100

error_msg

String

错误消息

最小长度:0

最大长度:1024

状态码: 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:100

error_msg

String

错误消息

最小长度:0

最大长度:1024

状态码: 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:100

error_msg

String

错误消息

最小长度:0

最大长度:1024

状态码: 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:100

error_msg

String

错误消息

最小长度:0

最大长度:1024

请求示例

响应示例

状态码: 200

successful operation

{
  "pipeline_id" : "string"
}

状态码

状态码

描述

200

successful operation

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

错误码

请参见错误码

相关文档