文档首页/ 应用与数据集成平台 ROMA Connect/ API参考/ 数据集成API/ 任务管理/ 批量启动或停止任务
更新时间：2024-07-03 GMT+08:00
在线调试
CLI示例
查看PDF
分享

批量启动或停止任务

功能介绍

批量启动或停止任务。

调试

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

URI

POST /v2/{project_id}/fdi/instances/{instance_id}/batch-operation/tasks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。

最小长度：1

最大长度：64

instance_id

是

String

实例ID。

最小长度：1

最大长度：64

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

action_id

是

String

操作类型。

  • start (启动)

  • stop (停止)

最小长度：1

最大长度：10

list

否

Array of TaskBean objects

需要启动或者停止的任务ID列表，list数组长度最大为10。

数组长度：1 - 9999
表4 TaskBean

参数

是否必选

参数类型

描述

task_id

否

String

任务ID, 可为空。

最小长度：1

最大长度：64

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

success_count

Integer

成功的个数。

最小值：0

最大值：999999

failure_count

Integer

失败的个数。

最小值：0

最大值：999999

failure

Array of TaskBeanFacade objects

失败的详情。

数组长度：0 - 999999

success

Array of TaskBeanFacade objects

成功的任务信息。

数组长度：0 - 999999
表6 TaskBeanFacade

参数

参数类型

描述

task_id

String

任务ID。

最小长度：1

最大长度：64

task_name

String

任务名称。

最小长度：1

最大长度：64

error_code

String

失败的错误码。

最小长度：0

最大长度：64

error_msg

String

错误详情。

最小长度：1

最大长度：64

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度：8

最大长度：36

error_msg

String

错误描述。

最小长度：2

最大长度：512

状态码： 404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度：8

最大长度：36

error_msg

String

错误描述。

最小长度：2

最大长度：512

状态码： 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度：8

最大长度：36

error_msg

String

错误描述。

最小长度：2

最大长度：512

请求示例

批量启动任务列表中的数据集成任务

{
  "action_id" : "start",
  "list" : [ {
    "task_id" : "49460e99d597464d885f871dd6acc894"
  } ]
}

响应示例

状态码： 400

Bad Request

{
  "error_code" : "FDI.3150",
  "error_msg" : "The task list is empty."
}

状态码： 404

Not Found

{
  "error_code" : "FDI.3083",
  "error_msg" : "One or more scheduled tasks are not configured with scheduled plans."
}

状态码

状态码

描述

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 任务管理

相关文档