查询训练作业列表
功能介绍
根据指定条件查询用户创建的训练作业。
URI
GET /v1/{project_id}/training-jobs
|
参数 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
status |
否 |
String |
作业状态的查询，默认为所有状态，例如查看创建失败的作业，可选的“status”为“3”|“5”|“6”|“13”，详细作业状态列表请参见作业状态参考。 |
|
per_page |
否 |
Integer |
指定每一页展示作业的总量，默认为10，“per_page”可选的范围为[1，1000]。 |
|
page |
否 |
Integer |
指定要查询页的索引，默认为1。“page”可选的范围为[1，65535]。 |
|
sortBy |
否 |
String |
指定查询的排序方式，默认是作业名称“job_name”，目前支持的排序还有作业描述“job_desc”，作业状态“status”，运行时长“duration”，作业版本数“version_count”以及创建时间 “create_time”。 |
|
order |
否 |
String |
可选值有：
|
|
search_content |
否 |
String |
指定要查询的文字信息，例如训练作业名字，默认为空，字符串的长度为[0，64]。 |
|
workspace_id |
否 |
String |
指定作业所处的工作空间，默认值为“0”。 |
请求消息
无。
响应消息
|
参数 |
参数类型 |
说明 |
|---|---|---|
|
is_success |
Boolean |
请求是否成功。 |
|
error_message |
String |
调用失败时的错误信息。 调用成功时无此字段。 |
|
error_code |
String |
调用失败时的错误码，具体请参见错误码。 调用成功时无此字段。 |
|
job_total_count |
Integer |
查询到的用户创建作业总数。 |
|
job_count_limit |
Integer |
用户还可以创建训练作业的数量。 |
|
jobs |
jobs结构数组 |
训练作业的属性列表，具体请参见表4。 |
|
quotas |
Integer |
训练作业的运行数量上限。 |
|
参数 |
参数类型 |
说明 |
|---|---|---|
|
job_id |
Long |
训练作业的ID。 |
|
job_name |
String |
训练作业的名称。 |
|
version_id |
Long |
训练作业的版本ID。 |
|
status |
Int |
训练作业的运行状态，详细作业状态列表请参见作业状态参考。 |
|
create_time |
Long |
训练作业的创建时间，时间戳格式。 |
|
duration |
Long |
训练作业的运行时长，单位为毫秒。 |
|
job_desc |
String |
训练作业的具体描述。 |
|
version_count |
Long |
训练作业的版本数。 |
请求示例
如下以查询训练作业状态为7，每页展示10条记录，指定到第1页，按照“job_name”排序并递增排列，查询作业名字中包含job的所有训练作业数据为例。
GET https://endpoint/v1/{project_id}/training-jobs?status=7&per_page=10&page=1&sortBy=job_name&order=asc&search_content=job
响应示例
- 成功响应示例
{ "is_success": true, "quotas": 5, "job_total_count": 1, "job_count_limit": 3, "jobs": [ { "job_id": 10, "job_name": "testModelArtsJob", "version_id": 10, "status": 10, "create_time": 1524189990635, "duration": 532003, "job_desc": "This is ModelArts job", "version_count": 5 } ] } - 失败响应示例
{ "is_success": false, "error_message": "Error string", "error_code": "ModelArts.0105" }
状态码
状态码请参见状态码。
