更新时间:2024-07-12 GMT+08:00
分享

获取基模型列表

功能介绍

获取基模型列表。

URI

GET /v1/{project_id}/base-models

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,您可以从获取项目ID中获取。

最小长度:1

最大长度:128

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

限制量,单次查询总量,必须由数字组成,默认为100,取值范围[1,1000]。

最小值:1

最大值:1000

缺省值:100

offset

Integer

偏移量,查询起始偏移,必须由数字组成,默认为0,取值范围[0,100000000]。

最小值:0

最大值:100000000

缺省值:0

sort_dir

String

排序规则目前默认时间升序。

缺省值:ASC

sort_key

String

排序规则目前默认时间升序,支持根据create_time排序。

缺省值:create_time

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。

最小长度:1

最大长度:32768

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

models

Array of BaseModelDto objects

模型列表。

count

Integer

模型总数。

表5 BaseModelDto

参数

参数类型

描述

name

String

模型名称。

id

String

模型ID。

create_time

String

模型创建时间。

description

String

模型描述信息。

请求示例

https://{endpoint}/v1/{project_id}/base-models

响应示例

状态码: 200

OK

{ 
  "count" : 1, 
  "models" : [ { 
    "id" : "56e0f1b0-ac10-46a5-8fa7-b26831d7d488", 
    "name" : "demo_name", 
    "description" : "description", 
    "create_time" : "2021-01-30T02:34:36Z"
  } ] 
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档