# 更新定制模型

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

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

调用本接口更新指定定制模型的名称或描述信息。本接口仅修改元数据，不会触发模型版本变更，也不会影响已基于该定制模型创建的在线推理接入点（Endpoint）。

> **说明：注意**
>
> 本接口仅更新定制模型的名称或描述等元数据信息，不会修改训练产物或版本。如需关联新的版本或修改其他属性，请使用对应的版本管理接口。

## 鉴权

本接口支持鉴权方式如下，详情请参见 [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。可通过 *ListCustomModels* 接口查询当前账号下的定制模型列表。

**ClientToken** `string` | 幂等令牌

用于保证请求幂等性的字符串。由调用方传入，需在不同请求之间保持唯一。重复携带同一 *ClientToken* 的请求只会被实际执行一次。

**Description** `string` | 定制模型描述

定制模型的新描述信息，用于补充说明模型用途、训练数据来源或版本说明等。

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

是否仅对此请求进行预检（DryRun），不实际执行更新。
- `true`：发送检查请求，仅校验参数与权限，不实际更新定制模型。
- `false`（默认）：发送正常请求，执行实际的更新操作。

**Name** `string` | 定制模型名称

定制模型的新名称，用于在控制台与 API 列表中识别该定制模型。建议使用具有业务含义的可读字符串。

## 响应参数

**Id** `string` | 定制模型 ID

被更新的定制模型 ID，与请求参数中的 *Id* 一致。


## 代码示例

## 默认

### cURL

#### Request

```bash
curl 'https://ark.cn-beijing.volcengineapi.com/?Action=UpdateCustomModel&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": "cm-id",
  "Name": "TestName",
  "Description": "TestDescription",
  "DryRun": true
}
'
```

#### Response

```
{
  "ResponseMetadata": {
    "RequestId": "20240514210804240055238131D7DFB2",
    "Action": "UpdateCustomModel",
    "Version": "2024-01-01",
    "Service": "ark",
    "Region": "cn-beijing"
  },
  "Result": {
    "Id": "cm-20240401114541-5gzd8"
  }
}
```