文档首页/ 数智融合计算服务 DataArts Fabric/ API参考/ API/ 模型定义/ 查看模型版本列表 - ListModelVersions
更新时间：2025-12-23 GMT+08:00
查看PDF
分享

查看模型版本列表 - ListModelVersions

功能介绍

查询模型的版本列表。用户可通过该接口查询模型版本列表，接口支持分页查询、支持通过名称、ID查询。返回为符合过滤条件的模型版本列表。此接口为同步接口，无配套使用接口和特殊场景。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    DataArtsFabric:model:show

    Read

    workspace *

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

    -

    -

    model *

    -

URI

GET /v1/workspaces/{workspace_id}/models/{model_id}/versions

表1 路径参数

参数

是否必选

参数类型

描述

workspace_id

是

String

参数解释：工作空间ID。获取方法，请参见获取工作空间ID。

约束限制：不涉及。

取值范围：长度为[1,36]的英文字符、数字和中划线(-)的组合。

默认取值：不涉及。

model_id

是

String

参数解释：模型ID。获取方法，请参见获取模型ID。

约束限制：不涉及。

取值范围：长度为[1,36]的英文字符、数字和中划线(-)的组合。

默认取值：不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释：偏移量，表示从此偏移量开始查询。

约束限制：不涉及。

取值范围：[0,1000000000]。

默认取值：0。

limit

否

Integer

参数解释：指定每一页返回的最大条目数。

约束限制：不涉及。

取值范围：[1,100]。

默认取值：10。

version_id

否

String

参数解释：模型版本ID。

约束限制：不涉及。

取值范围：长度为[32,36]的英文字符、数字和中划线(-)的组合。

默认取值：不涉及。

name

否

String

参数解释：模型版本名称，支持模糊查询。

约束限制：不涉及。

取值范围：长度为[4,32]的英文字符、数字、中划线(-)和下划线(_)的组合。

默认取值：不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

参数解释：租户Token。用于调用接口的认证。获取方法，请参见认证鉴权。

约束限制：不涉及。

取值范围：长度不超过65534个字符。

默认取值：不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

total

Integer

参数解释：符合条件的Version总数。

约束限制：不涉及。

取值范围：[0,10000]。

默认取值：不涉及。

versions

Array of ModelVersionInfo objects

参数解释：列表信息。

约束限制：[0,10000]。
表5 ModelVersionInfo

参数

参数类型

描述

id

String

参数解释：模型版本ID。

约束限制：系统自动生成无法修改，输入不生效。

取值范围：长度为[32,36]的英文字符、数字和中划线(-)的组合。

默认取值：不涉及。

name

String

参数解释：模型版本名称。

约束限制：不涉及。

取值范围：长度为[1,64]的中文、字母、数字、下划线(_)、中划线(-)、半角句号（.）、空格的组合。

默认取值：不涉及。

cap_white_list

Array of strings

参数解释：镜像包白名单。

约束限制：[0,100]。

description

String

参数解释：描述信息。

约束限制：不涉及。

取值范围：[0,1024]。

默认取值：不涉及。

config

ModelConfig object

参数解释：模型配置。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

create_time

String

参数解释：创建时间。

约束限制：不涉及。

取值范围：不涉及。

默认取值：不涉及。

create_user

User object

参数解释：租户信息内容，包含账户名称、账户ID和用户名称、用户ID。

约束限制：不涉及。
表6 ModelConfig

参数

参数类型

描述

llm_model_config

LlmModelConfig object

参数解释：Llm模型配置。

约束限制：不涉及。
表7 LlmModelConfig

参数

参数类型

描述

base_model_type

String

参数解释：基模型类型。

约束限制：不涉及。

取值范围：请从列举基模型接口响应中获取。

默认取值：不涉及。

model_path

String

参数解释：模型文件路径。

约束限制：合法OBS路径。

取值范围：不涉及。

默认取值：不涉及。

local_model_path

String

参数解释：本地模型文件路径。

约束限制：本地模型文件路径。

取值范围：不涉及。

默认取值：不涉及。
表8 User

参数

参数类型

描述

domain_name

String

参数解释：账户名称。

约束限制：不涉及。

取值范围：长度为[0,64]个字符。

默认取值：不涉及。

domain_id

String

参数解释：账号ID。

约束限制：不涉及。

取值范围：长度为[1,36]的数字、英文字符和中划线(-)的组合。

默认取值：不涉及。

user_name

String

参数解释：用户名称。

约束限制：不涉及。

取值范围：长度为[0,64]个字符。

默认取值：不涉及。

user_id

String

参数解释：用户ID。

约束限制：不涉及。

取值范围：长度为[1,36]的数字、英文字符和中划线(-)的组合。

默认取值：不涉及。

状态码：400

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

约束限制：不涉及。

取值范围：长度为[8,36]个字符。

默认取值：不涉及。

error_msg

String

参数解释：错误描述。

约束限制：不涉及。

取值范围：长度为[2,512]个字符。

默认取值：不涉及。

solution_msg

String

参数解释：解决方案描述。

约束限制：不涉及。

取值范围：长度为[0,4096]个字符。

默认取值：不涉及。

状态码：401

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

约束限制：不涉及。

取值范围：长度为[8,36]个字符。

默认取值：不涉及。

error_msg

String

参数解释：错误描述。

约束限制：不涉及。

取值范围：长度为[2,512]个字符。

默认取值：不涉及。

solution_msg

String

参数解释：解决方案描述。

约束限制：不涉及。

取值范围：长度为[0,4096]个字符。

默认取值：不涉及。

状态码：404

表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

约束限制：不涉及。

取值范围：长度为[8,36]个字符。

默认取值：不涉及。

error_msg

String

参数解释：错误描述。

约束限制：不涉及。

取值范围：长度为[2,512]个字符。

默认取值：不涉及。

solution_msg

String

参数解释：解决方案描述。

约束限制：不涉及。

取值范围：长度为[0,4096]个字符。

默认取值：不涉及。

状态码：408

表12 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

约束限制：不涉及。

取值范围：长度为[8,36]个字符。

默认取值：不涉及。

error_msg

String

参数解释：错误描述。

约束限制：不涉及。

取值范围：长度为[2,512]个字符。

默认取值：不涉及。

solution_msg

String

参数解释：解决方案描述。

约束限制：不涉及。

取值范围：长度为[0,4096]个字符。

默认取值：不涉及。

状态码：500

表13 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

约束限制：不涉及。

取值范围：长度为[8,36]个字符。

默认取值：不涉及。

error_msg

String

参数解释：错误描述。

约束限制：不涉及。

取值范围：长度为[2,512]个字符。

默认取值：不涉及。

solution_msg

String

参数解释：解决方案描述。

约束限制：不涉及。

取值范围：长度为[0,4096]个字符。

默认取值：不涉及。

请求示例

GET https://{endpoint}/v1/workspaces/{workspace_id}/models/{model_id}/versions

响应示例

状态码：200

查询模型版本列表的响应体。

{
  "total" : 1,
  "versions" : [ {
    "id" : "0b5633ba2b904511ad514346f4d23d4b",
    "name" : "name",
    "cap_white_list" : [ "cap1 cap2 ca* cap*" ],
    "description" : "description",
    "config" : {
      "llm_model_config" : {
        "base_model_type" : "string",
        "model_path" : "obs://bucketname/objectdir/modelpath/"
      }
    },
    "create_time" : "2023-05-30T12:24:30.401Z",
    "create_user" : {
      "domain_name" : "string",
      "domain_id" : "0b5633ba2b904511ad514346f4d23d4b",
      "user_name" : "string",
      "user_id" : "0b5633ba2b904511ad514346f4d23d4b"
    }
  } ]
}

状态码：400

BadRequest

{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}

状态码：401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码：403

Forbidden

{
  "error" : {
    "code" : "403",
    "message" : "X-Auth-Token is invalid in the request",
    "title" : "Forbidden"
  },
  "error_code" : 403,
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}

状态码：404

NotFound

{
  "error_code" : "common.01000001",
  "error_msg" : "response status exception, code: 404"
}

状态码：408

Request Time-out

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

状态码：500

InternalServerError

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error"
}

状态码

状态码

描述

200

查询模型版本列表的响应体。

400

BadRequest

401

Unauthorized

403

Forbidden

404

NotFound

408

Request Time-out

500

InternalServerError

错误码

请参见错误码。

父主题： 模型定义

相关文档