获取基模型列表
功能介绍
获取基模型列表。
URI
GET /v1/{project_id}/base-models
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,您可以从获取项目ID中获取。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
Integer |
参数解释: 限制量,单次查询总量。 约束限制: 不涉及 取值范围: 1-100 默认取值: 100 |
offset |
否 |
Integer |
参数解释: 偏移量,查询起始偏移。 约束限制: 不涉及 取值范围: 0-100000000 默认取值: 0 |
sort_dir |
否 |
String |
参数解释: 排序规则。 约束限制: 不涉及 取值范围:
默认取值: ASC |
sort_key |
否 |
String |
参数解释: 排序规则。 约束限制: 目前默认时间降序,支持根据create_time排序。 取值范围:
默认取值: create_time |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 约束限制: 不涉及 取值范围: 长度为[1-32768]个字符。 默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
models |
Array of BaseModelDto objects |
参数解释: 模型列表。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
count |
Integer |
参数解释: 模型总数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求示例
获取基模型列表。
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 |
错误码
请参见错误码。