# 更新批量推理任务

> 全部文档的索引见 [llms.txt](https://ark.volcengine.com/llms.txt)；在任一文档页面地址后追加 `.md` 可获取该页的 Markdown 版本。

`POST https://ark.cn-beijing.volcengineapi.com/?Action=UpdateBatchInferenceJob&Version=2024-01-01`

更新批量推理任务的名称或描述信息。

> **说明**
>
> 更新接口仅支持修改 *Name* 与 *Description*。任务的模型引用、输入输出位置、最大等待时间等关键参数在创建后不可变更。

## 鉴权

本接口支持鉴权方式如下，详情请参见 [Base URL 及鉴权](/docs/base-url-and-authentication)。

* Access Key 鉴权，请在 [Access Key 管理](https://console.volcengine.com/iam/keymanage) 页面，获取 Access Key。本接口仅支持 Access Key 鉴权。

---

<span id="request-parameters"></span>
## 请求参数

### Body 参数

**Id** `string` `必选` | 任务 ID

待更新的批量推理任务 ID。

**Description** `string` | 任务描述

批量推理任务的描述信息。

**DryRun** `boolean` `默认值 false` | 预检请求

是否仅对此请求进行预检。`true` 表示发送检查请求；`false` 表示发送正常请求，执行更新操作。

**Name** `string` | 任务名称

批量推理任务名称。

## 响应参数

本接口无特有的返回参数，成功时 HTTP 状态码为 `200`，返回结构中 `Result` 为空对象 `{}`。


## 代码示例

## 默认

### cURL

#### Request

```bash
curl 'https://ark.cn-beijing.volcengineapi.com/?Action=UpdateBatchInferenceJob&Version=2024-01-01' \
  -H 'Content-Type: application/json' \
  -H 'X-Date: <X-Date>' \
  -H 'X-Content-Sha256: <X-Content-Sha256>' \
  -H 'Authorization: HMAC-SHA256 Credential=<AK>/<X-Date>/cn-beijing/ark/request, SignedHeaders=content-type;host;x-content-sha256;x-date, Signature=<Signature>' \
  -d '{
    "Id": "bi-20240918194641-r2nwq",
    "Name": "批量推理任务（重命名）",
    "Description": "更新后的描述",
    "DryRun": true
}
'
```

#### Response

```
{
  "ResponseMetadata": {
    "RequestId": "20241101204820216194191074D4638D",
    "Action": "UpdateBatchInferenceJob",
    "Version": "2024-01-01",
    "Service": "ark",
    "Region": "cn-beijing"
  },
  "Result": {}
}
```