BatchUpdateTasks - 批量更新任务

更新时间:
复制 MD 格式

以增量更新的方式,批量更新多个任务。

接口说明

需要购买 DataWorks 基础版及以上版本才能使用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

Tasks

array<object>

任务列表。

array<object>

Id

integer

任务 ID。

1234

EnvType

string

项目环境。

  • Prod:生产

  • Dev:开发

枚举值:

  • Prod :

    生产

  • Dev :

    开发

Prod

Name

string

名称。

SQL node

Description

string

描述信息。

test

Owner

string

任务的责任人的账号 ID。

1000

Timeout

integer

任务执行超时时间,单位秒。取值应大于 3600。

3600

RerunMode

string

任务是否允许重跑的配置。

  • AllDenied:失败或成功都不可重跑

  • FailureAllowed:只有失败可重跑

  • AllAllowed:失败或成功均可重跑

枚举值:

  • AllDenied :

    失败或成功都不可重跑

  • FailureAllowed :

    只有失败可重跑

  • AllAllowed :

    失败或成功均可重跑

AllAllowed

RerunTimes

integer

重试次数,当任务设置为可重跑时生效。

3

RerunInterval

integer

重试时间间隔,单位秒。

60

Trigger

object

任务触发方式。

Type

string

触发方式类型。

  • Scheduler:调度周期触发

  • Manual:手动触发

枚举值:

  • Scheduler :

    调度周期触发

  • Manual :

    手动触发

Scheduler

Recurrence

string

触发时的运行模式,type=Scheduler 时生效。

  • Pause:暂停

  • Skip:空跑

  • Normal:正常运行

枚举值:

  • Pause :

    暂停

  • Skip :

    空跑

  • Normal :

    正常运行

Normal

Cron

string

Cron 表达式,type=Scheduler 时生效。

00 00 00 * * ?

StartTime

string

周期触发生效时间,type=Scheduler 时生效。格式为yyyy-mm-dd hh:mm:ss

1970-01-01 00:00:00

EndTime

string

周期触发失效时间,type=Scheduler 时生效。格式为yyyy-mm-dd hh:mm:ss

9999-01-01 00:00:00

RuntimeResource

object

运行环境配置,如资源组信息。

ResourceGroupId

string

任务运行配置的调度资源组标识符。

S_res_group_524258031846018_1684XXXXXXXXX

Image

string

任务运行配置的镜像 ID。

i-xxxxxx

Cu

string

任务运行配置 CU 消耗。

0.25

DataSource

object

关联数据源信息。

Name

string

数据源名称。

odps_test

Tags

array<object>

任务标签列表。

object

Key

string

标签键。

key1

Value

string

标签值。

value1

Comment

string

备注信息。

this is a comment

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求的 ID。用于定位日志,排查问题。

22C97E95-F023-56B5-8852-B1A77A17XXXX

SuccessInfo

object

批量操作的结果信息。结构为 Map,以任务 ID 为键,以结果信息为 Value。

object

结果信息。

Success

boolean

操作是否成功。

true

Message

string

错误信息。

The task does not exist.

示例

正常返回示例

JSON格式

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "SuccessInfo": {
    "key": {
      "Success": true,
      "Message": "The task does not exist."
    }
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情