文档

UpdateBatch - 更新批处理任务

更新时间:

更新批处理任务信息,如输入的数据源配置、数据处理的配置、批处理任务标签等信息。

接口说明

  • 更新批处理任务时,当批处理任务状态处于 Ready(就绪)或 Failed(失败)时可以更新,更新时不会改变当前的任务状态。
  • 更新完成后,之前未完成的批处理任务不会继续自动执行,您可以调用 ResumeBatch 接口恢复此批处理任务的执行。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
imm:UpdateBatch
  • 全部资源
    *
imm:UpdateBatch
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ProjectNamestring

项目名称,获取方式请参见创建项目

test-project
Idstring

批处理任务 ID,获取方式请参见创建批处理

batch-4eb9223f-3e88-42d3-a578-3f2852******
InputInput

输入的数据源配置。

Actionsarray<object>

处理模板列表。

object

模板信息。

Namestring

模板名称。

doc/convert
Parametersarray

模版参数列表。

string

模版参数。

pages=3
Tagsobject

自定义标签,用于对异步任务进行搜索、过滤。

{"key":"val"}

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

CB4D73A3-BAF4-4A9D-A631-15F219AF****

示例

正常返回示例

JSON格式

{
  "RequestId": "CB4D73A3-BAF4-4A9D-A631-15F219AF****"
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-07-05OpenAPI 入参发生变更查看变更详情