文档首页/ 数智融合计算服务 DataArtsFabric/ API参考/ API/ 模型定义/ 查询模型列表

更新时间：2025-04-28 GMT+08:00

查看PDF

查询模型列表

功能介绍

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

调试

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

URI

GET https://localhost.com/v1/workspaces/{workspace_id}/models

表1 路径参数
参数	是否必选	参数类型	描述
workspace_id	是	String	参数解释：工作空间ID。获取方法，请参见获取工作空间ID。约束限制：不涉及。取值范围：长度为[1,36]的英文字符、数字和中划线(-)的组合。默认取值：不涉及。

表2 Query参数
参数	是否必选	参数类型	描述
offset	否	Integer	参数解释：偏移量，表示从此偏移量开始查询。约束限制：不涉及。取值范围：[0,1000000000]。默认取值：0。
limit	否	Integer	参数解释：指定每一页返回的最大条目数。约束限制：不涉及。取值范围：[1,100]。默认取值：10。
name	否	String	参数解释：通过名字搜索Model，支持模糊查询。约束限制：不涉及。取值范围：长度为[1,128]的英文字符、数字、中划线(-)和下划线(_)的组合默认取值：不涉及。
id	否	String	参数解释：通过模型ID检索。约束限制：不涉及。取值范围：长度为[32,36]的英文字符、数字和中划线(-)的组合，请参见获取模型ID。默认取值：不涉及。
type	否	String	参数解释：通过模型类型检索。约束限制：不涉及。取值范围：长度为[1,128]个字符。默认取值：不涉及。
visibility	否	String	参数解释：可见性检索的参数。约束限制：不涉及。取值范围： PRIVATE：私有，用户自己创建的； PUBLIC：公共，查询所有公共的，包括其他用户创建的； ALL：所有的。默认取值：默认为空，不填表示不限制，则查出当前用户下的，包括PRIVATE和PUBLIC，不包括其他用户创建的。
sort_by	否	String	参数解释：指定排序字段。约束限制：不涉及。取值范围： CREATE_TIME：创建时间，默认值； UPDATE_TIME：更新时间； NAME：服务名称。默认取值：不涉及。
order_by	否	String	参数解释：排序方式。约束限制：不涉及。取值范围： ASC：递增排序； DESC：递减排序。默认取值：DESC。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	否	String	参数解释：租户Token。用于调用接口的认证。获取方法，请参见认证鉴权。约束限制：不涉及。取值范围：长度不超过65534个字符。默认取值：不涉及。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
total	Integer	参数解释：符合条件的总数。约束限制：不涉及。取值范围：[0,10000]。默认取值：不涉及。
models	Array of ModelInfo objects	参数解释：符合条件的总数。约束限制：不涉及。取值范围：[0,1000]。默认取值：不涉及。

表5 ModelInfo
参数	参数类型	描述
visibility	String	参数解释：可见性。约束限制：不涉及。取值范围： PRIVATE：私有 PUBLIC：公共默认取值：PRIVATE。
id	String	参数解释：模型ID。获取方法，请参见获取模型ID。约束限制：不涉及。取值范围：长度为[32,36]的英文字符、数字和中划线(-)的组合。默认取值：不涉及。
name	String	参数解释：一个Model的名称。约束限制：不涉及。取值范围：长度为[1,64]的中文、字母、数字、下划线(_)、中划线(-)、半角句号（.）、空格的组合。默认取值：不涉及。
description	String	参数解释：描述信息。约束限制：不涉及。取值范围：[0,1024]。默认取值：不涉及。
type	String	参数解释：模型的类型。约束限制：不涉及。取值范围：LLM_MODEL：大语言模型。默认取值：不涉及。
create_time	String	参数解释：创建时间。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
update_time	String	参数解释：更新时间。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
current_version	ModelVersionInfo object	参数解释：模型版本详情信息。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
create_user	User object	参数解释：租户信息内容，包含账户名称、账户ID和用户名称、用户ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
update_user	User object	参数解释：租户信息内容，包含账户名称、账户ID和用户名称、用户ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

表6 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。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

表7 ModelConfig
参数	参数类型	描述
llm_model_config	LlmModelConfig object	参数解释：Llm模型配置。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

表8 LlmModelConfig
参数	参数类型	描述
base_model_type	String	参数解释：基模型类型。请从ListBaseModels列举基模型接口响应中获取。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
model_path	String	参数解释：模型文件路径。约束限制：合法OBS路径。取值范围：不涉及。默认取值：不涉及。

表9 User
参数	参数类型	描述
domain_name	String	参数解释：账户名称。约束限制：不涉及。取值范围：长度为[0,64]个字符。默认取值：不涉及。
domain_id	String	参数解释：账号ID。约束限制：不涉及。取值范围：长度为[1,36]的数字、英文字符和中划线(-)的组合。默认取值：不涉及。
user_name	String	参数解释：用户名称。约束限制：不涉及。取值范围：长度为[0,64]个字符。默认取值：不涉及。
user_id	String	参数解释：用户ID。约束限制：不涉及。取值范围：长度为[1,36]的数字、英文字符和中划线(-)的组合。默认取值：不涉及。

状态码：400

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。约束限制：不涉及。取值范围：长度为[8,36]个字符。默认取值：不涉及。
error_msg	String	参数解释：错误描述。约束限制：不涉及。取值范围：长度为[2,512]个字符。默认取值：不涉及。
solution_msg	String	参数解释：解决方案描述。约束限制：不涉及。取值范围：长度为[0,4096]个字符。默认取值：不涉及。

状态码：401

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。约束限制：不涉及。取值范围：长度为[8,36]个字符。默认取值：不涉及。
error_msg	String	参数解释：错误描述。约束限制：不涉及。取值范围：长度为[2,512]个字符。默认取值：不涉及。
solution_msg	String	参数解释：解决方案描述。约束限制：不涉及。取值范围：长度为[0,4096]个字符。默认取值：不涉及。

状态码：404

**表12** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。约束限制：不涉及。取值范围：长度为[8,36]个字符。默认取值：不涉及。
error_msg	String	参数解释：错误描述。约束限制：不涉及。取值范围：长度为[2,512]个字符。默认取值：不涉及。
solution_msg	String	参数解释：解决方案描述。约束限制：不涉及。取值范围：长度为[0,4096]个字符。默认取值：不涉及。

状态码：408

**表13** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。约束限制：不涉及。取值范围：长度为[8,36]个字符。默认取值：不涉及。
error_msg	String	参数解释：错误描述。约束限制：不涉及。取值范围：长度为[2,512]个字符。默认取值：不涉及。
solution_msg	String	参数解释：解决方案描述。约束限制：不涉及。取值范围：长度为[0,4096]个字符。默认取值：不涉及。

状态码：500

**表14** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。约束限制：不涉及。取值范围：长度为[8,36]个字符。默认取值：不涉及。
error_msg	String	参数解释：错误描述。约束限制：不涉及。取值范围：长度为[2,512]个字符。默认取值：不涉及。
solution_msg	String	参数解释：解决方案描述。约束限制：不涉及。取值范围：长度为[0,4096]个字符。默认取值：不涉及。

请求示例

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

响应示例

状态码：200

查询模型列表的响应体。

{
  "total" : 10,
  "models" : [ {
    "visibility" : "PRIVATE",
    "id" : "0b5633ba2b904511ad514346f4d23d4b",
    "name" : "LLama3-8b",
    "description" : "description",
    "type" : "LLM_MODEL",
    "create_time" : "2023-05-30T12:24:30.401Z",
    "update_time" : "2023-05-30T12:24:30.401Z",
    "current_version" : {
      "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"
      }
    },
    "create_user" : {
      "domain_name" : "string",
      "domain_id" : "0b5633ba2b904511ad514346f4d23d4b",
      "user_name" : "string",
      "user_id" : "0b5633ba2b904511ad514346f4d23d4b"
    },
    "update_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

错误码

请参见错误码。

父主题： 模型定义

上一篇：创建模型

下一篇：列举基模型

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

盘古Doer提问云社区提问