停止管道作业
功能介绍
停止一个正在运行中的管道作业
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v1/{project_id}/pipelines/{pipeline_id}/stop
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 项目ID 最小长度：1 最大长度：128 |
pipeline_id | 是 | String | 管道ID 最小长度：1 最大长度：100 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
trigger_savepoint | 否 | Boolean | 停止管道作业触发savepoint 缺省值：false |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 租户Token 最小长度：1 最大长度：65535 |
响应参数
状态码： 200
参数 | 参数类型 | 描述 |
|---|---|---|
pipeline_id | String | 管道ID 最小长度：1 最大长度：100 |
状态码： 400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 最小长度：1 最大长度：100 |
error_msg | String | 错误消息 最小长度：0 最大长度：1024 |
状态码： 401
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 最小长度：1 最大长度：100 |
error_msg | String | 错误消息 最小长度：0 最大长度：1024 |
状态码： 403
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 最小长度：1 最大长度：100 |
error_msg | String | 错误消息 最小长度：0 最大长度：1024 |
状态码： 500
参数 | 参数类型 | 描述 |
|---|---|---|
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 |
错误码
请参见错误码。
