查询训练实验列表
功能介绍
查询训练实验列表接口用于获取ModelArts平台上用户已创建的训练实验的列表。
该接口适用于以下场景：当用户需要查看所有或部分训练实验的概要信息，如实验名称、描述、创建时间等时，可以通过此接口查询训练实验列表。使用该接口的前提条件是用户已登录ModelArts平台并具有查看训练实验的权限。查询操作完成后，系统将返回符合条件的训练实验列表。若用户无权限操作或查询条件不合法，接口将返回相应的错误信息。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/training-experiments
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释：用户项目ID。获取方法请参见获取项目ID和名称。 约束限制：1 - 64字符，字母、数字和中划线。 取值范围：不涉及。 默认取值：不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
workspace_id |
否 |
String |
参数解释：工作空间ID。获取方法请参见查询工作空间列表。 约束限制：存在并使用的工作空间。 取值范围：不涉及。 默认取值：“0”。 |
|
limit |
否 |
Integer |
参数解释：返回的数据条目数。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
offset |
否 |
Integer |
参数解释：数据条目偏移量。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
sort_by |
否 |
String |
参数解释：排序依据字段，例如sort_by=update_time，则表示以条目的更新时间进行排序。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
|
order |
否 |
String |
参数解释：排序的方式。 约束限制：该字段必须与sort_by同时使用。 取值范围：枚举值：
默认取值：desc。 |
请求参数
无
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
参数解释：查询到所有训练实验总数。 取值范围：不涉及。 |
|
count |
Integer |
参数解释：查询到所有符合查询条件的训练实验总数。 取值范围：不涉及。 |
|
limit |
Integer |
参数解释：查询到所有训练实验限制个数。 取值范围：不涉及。 |
|
offset |
Integer |
参数解释：查询到所有训练实验查询偏移量。 取值范围：不涉及。 |
|
sort_by |
String |
参数解释：查询到所有训练实验排序依赖字段。 取值范围：不涉及。 |
|
order |
String |
参数解释：查询到所有训练实验排序方式。 取值范围： - asc：升序 - desc：降序 |
|
items |
Array of TrainingExperimentResponse objects |
参数解释：查询到所有符合查询条件的训练实验详情。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
metadata |
参数解释：训练实验数据。 |
|
|
statistic |
TrainingExperimentStatistic object |
参数解释：训练实验的统计数据。 |
请求示例
GET https://endpoint/v2/{project_id}/training-experiments?limit=50&offset=0&sort_by=update_time&order=desc&workspace_id=0
响应示例
状态码：200
OK
{
"total" : 2,
"count" : 2,
"limit" : 50,
"offset" : 0,
"sort_by" : "update_time",
"order" : "desc",
"items" : [ {
"metadata" : {
"id" : "8f583924-3e69-46f0-a18a-12de68d99295",
"name" : "autotest_experimen_w0v04g",
"description" : "创建训练作业时新建实验分组",
"create_time" : 1749718901720,
"workspace_id" : "0",
"update_time" : 1749718902000
},
"statistic" : {
"job_count" : 0
}
}, {
"metadata" : {
"id" : "a2b141a8-7f76-497b-ae82-e8510c4a0168",
"name" : "autotest_experimen_121643",
"description" : "查询作业实验列表",
"create_time" : 1749718899517,
"workspace_id" : "0",
"update_time" : 1749718899000
},
"statistic" : {
"job_count" : 1
}
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。
