批量更新作业-BatchUpdateJob

功能介绍

批量更新作业

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

octopus:dataJob:update

Write

workspace *

-

-

-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
octopus:dataJob:update	Write	workspace *	-	-	-

URI

PUT /v1.0/{project_id}/data/jobs

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目ID，获取方法请参见获取项目ID。约束限制：不涉及取值范围：不涉及默认取值：不涉及

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）约束限制：不涉及取值范围：不涉及默认取值：不涉及
Content-Type	是	String	参数解释：内容类型。填application/json 约束限制：不涉及取值范围：不涉及默认取值：不涉及

表3 请求Body参数
参数	是否必选	参数类型	描述
[数组元素]	是	Array of JobBatchUpdateRequestItem objects	请求内容，最多50组

表4 JobBatchUpdateRequestItem
参数	是否必选	参数类型	描述
id	是	Long	参数解释：作业ID 约束限制：不涉及取值范围：不涉及默认取值：不涉及
action	是	String	参数解释：操作类型约束限制：不涉及取值范围： STOP：停止作业 RESTART：重启作业默认取值：不涉及
resource_spec	否	String	参数解释：资源规格约束限制：不涉及取值范围：不涉及默认取值：不涉及
cluster_type	否	String	参数解释：集群类型约束限制：不涉及取值范围： CCE MODELARTS 默认取值：不涉及
cluster_id	否	String	参数解释：集群ID 约束限制：不涉及取值范围：不涉及默认取值：不涉及

响应参数

状态码：200

表5 响应Body参数
参数	参数类型	描述
payload	DataJobBatchOperationCommonResoponse object	参数解释：实际返回信息
meta_info	RespMetaInfo object	参数解释：元数据

表6 DataJobBatchOperationCommonResoponse
参数	参数类型	描述
list	Array of DataJobBatchDeleteResponse objects	参数解释：返回结果列表

表7 DataJobBatchDeleteResponse
参数	参数类型	描述
id	Long	参数解释：作业ID 取值范围：不涉及
result	String	参数解释：结果取值范围： SUCCESS：成功 FAILED：失败
error_msg	String	参数解释：错误原因取值范围：不涉及

表8 RespMetaInfo
参数	参数类型	描述
current_time	String	参数解释：请求时间，UTC时间格式，时间为UTC标准时间取值范围：不涉及

请求示例

批量操作作业

PUT https://{endpoint}/v1.0/{project_id}/data/jobs

[ {
  "id" : 1,
  "action" : "STOP"
}, {
  "id" : 2,
  "action" : "STOP"
} ]

响应示例

状态码：200

更新结果

{
  "meta_info" : {
    "current_time" : "2022-01-01T08:08:29Z"
  },
  "payload" : {
    "list" : [ {
      "id" : 1,
      "result" : "SUCCESS"
    }, {
      "id" : 2,
      "result" : "FAILED",
      "error_msg" : "The job does not exists."
    } ]
  }
}