# 获取定制模型信息

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

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

获取指定定制模型的详细信息，包括模型名称、来源类型、训练超参数、标签等。

> **说明：注意**
>
> 本接口仅返回当前账号下可见的定制模型，跨项目查询需指定正确的 ProjectName。

## 鉴权

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

## 响应参数

**AvailableDeploymentTypes** `string[]` | 支持的部署类型列

定制模型支持的部署类型列表

**Compressible** `boolean` | 是否支持压缩

定制模型是否支持压缩

**CompressionJobs** `object[]` | 压缩任务列表

定制模型关联的压缩任务列表

**CreateTime** `string` | 创建时间

`CompressionJobs.CreateTime`

压缩任务的创建时间

**Index** `integer` | 任务序号

`CompressionJobs.Index`

压缩任务在列表中的序号

**Phase** `string` | 任务阶段

`CompressionJobs.Phase`

压缩任务当前所处的阶段。可选值：`Completed`、`Failed`、`Running`。

**PhaseTime** `string` | 阶段时间

`CompressionJobs.PhaseTime`

压缩任务进入当前阶段的时间

**Message** `string` | 任务消息

`CompressionJobs.Message`

压缩任务相关的描述信息

**Config** `object` | 定制模型配置

定制模型的配置信息

**ModelType** `string` | 模型类型

`Config.ModelType`

模型类型标识

**CreateTime** `string` | 创建时间

定制模型的创建时间，RFC 3339 格式。

**CustomizationType** `string` | 定制类型

精调方式。例如 `FinetuneLoRA` 表示 LoRA 精调。

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

定制模型的描述信息

**Encrypted** `boolean` | 是否已加密

定制模型是否已加密

**FoundationModel** `object` | 基础模型引用

定制模型所基于的基础模型信息

**ModelVersion** `string` | 基础模型版本

`FoundationModel.ModelVersion`

基础模型版本号

**Name** `string` | 基础模型名称

`FoundationModel.Name`

**ConfigurationId** `string` | 基础模型配置 ID

`FoundationModel.ConfigurationId`

**HyperParameters** `object[]` | 超参列表

训练该定制模型时使用的超参数列表

**Name** `string` | 参数名

`HyperParameters.Name`

超参数的参数名

**Value** `string` | 参数值

`HyperParameters.Value`

超参数的参数值

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

定制模型的 ID

**LoraBaseModelAvailable** `boolean` | LoRA 基础模型是否可用

如果当前定制模型是基于全量 SFT 模型增量精调得到的，该字段表示全量 SFT 模型是否仍然有效：`true` 表示全量 SFT 模型仍可用；`false` 表示全量 SFT 模型当前不可用，将影响本模型的可用性。

**ModelCustomizationJobId** `string` | 调优任务 ID

创建该定制模型的精调任务 ID

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

定制模型的名称

**OwnerAccountId** `number` | 拥有者账号 ID

拥有该定制模型的账号 ID

**ProjectName** `string` | 项目名称

定制模型所属的项目名称

**ResourceOrigin** `string` | 资源来源

资源来源标识

**SourceModelAvailable** `boolean` | 源模型是否可用

如果当前定制模型是基于某共享模型增量训练得到的，该字段表示来源共享模型是否仍然有效：`true` 表示来源共享模型仍可用；`false` 表示来源共享模型当前不可用，将影响本模型的可用性。

**SourceType** `string` | 来源类型

定制模型的来源类型。例如 `Customization` 表示通过精调任务产生。

**Status** `string` | 定制模型状态

定制模型的当前状态。取值包括 `Ready`（就绪）等。

**SupportInferenceFoundry** `boolean` | 是否支持推理铸造

定制模型是否支持推理铸造

**Tags** `object[]` | 标签列表

定制模型关联的标签列表

**Key** `string` | 标签键

`Tags.Key`

**Value** `string` | 标签值

`Tags.Value`

**TosConfig** `object` | TOS 存储配置

定制模型的 TOS 存储配置信息

**BucketName** `string` | TOS 桶名称

`TosConfig.BucketName`

**PrefixPath** `string` | TOS 文件夹路径

`TosConfig.PrefixPath`

**UpdateTime** `string` | 更新时间

定制模型的最近更新时间，RFC 3339 格式。


## 代码示例

## 默认

### cURL

#### Request

```bash
curl 'https://ark.cn-beijing.volcengineapi.com/?Action=GetCustomModel&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"
}
'
```

#### Response

```
{
  "ResponseMetadata": {
    "RequestId": "2024051421034216322206625187C9AD",
    "Action": "GetCustomModel",
    "Version": "2024-01-01",
    "Service": "ark",
    "Region": "cn-beijing"
  },
  "Result": {
    "CustomModel": {
      "Id": "cm-20240514210342-9k4hn",
      "Name": "自定义模型-电商图像生成",
      "Description": "基于 doubao-seed-2-0-pro 的 LoRA 精调模型 · 用于电商场景图像生成",
      "SourceType": "Customization",
      "ModelCustomizationJobId": "mcj-20240401114541-5gzd8",
      "CustomizationType": "FinetuneLoRA",
      "Status": "Ready",
      "HyperParameters": [
        {
          "Name": "learning_rate",
          "Value": "0.0001"
        }
      ],
      "FoundationModel": {
        "Name": "doubao-seed-2-0-pro",
        "ModelVersion": "260215"
      },
      "Tags": [
        {
          "Key": "env",
          "Value": "stg"
        }
      ],
      "ProjectName": "default",
      "CreateTime": "2024-04-01T11:54:41Z",
      "UpdateTime": "2024-05-14T20:59:45Z"
    }
  }
}
```