查询可视化作业列表
功能介绍
根据指定条件查询用户创建的可视化作业列表。
URI
GET /v1/{project_id}/visualization-jobs
|
参数 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
status |
否 |
String |
作业状态的查询，默认为所有状态，例如查看创建失败的作业，可选的“status”为“3”|“5”|“6”|“13”，详细作业状态列表请查看作业状态参考。 |
|
per_page |
否 |
Integer |
指定每一页展示作业的总量，默认为“10”，“per_page”可选的范围为[1，1000]。 |
|
page |
否 |
Integer |
指定要查询页的索引，默认为“1”。 |
|
sortBy |
否 |
String |
指定查询的排序方式，默认是作业名称作业id“job_id” ，目前支持的排序还有作业名称“job_name”,作业描述“job_desc”，创建时间“create_time” ，作业状态“status”。 |
|
order |
否 |
String |
可选值。
|
|
search_content |
否 |
String |
指定要查询的文字信息，例如可视化作业名字，默认为空，字符串的长度为[0，64]。 |
|
workspace_id |
否 |
String |
指定作业所处的工作空间，默认值为“0”。 |
请求消息
无请求参数。
响应消息
|
参数 |
参数类型 |
说明 |
|---|---|---|
|
job_name |
String |
可视化作业的名称。 |
|
status |
Integer |
可视化作业的运行状态，详细作业状态列表请参见作业状态参考。 |
|
create_time |
Long |
可视化作业的创建时间。 |
|
duration |
Long |
可视化作业的运行时长，单位为毫秒。 |
|
job_desc |
String |
可视化作业的具体描述。 |
|
service_url |
String |
可视化作业的endpoint。 |
|
train_url |
String |
可视化作业的日志存储路径。 |
|
job_id |
Long |
可视化作业的ID。 |
|
resource_id |
String |
可视化作业的计费资源ID。 |
请求示例
如下以查询正在部署中的作业，按递增排序，显示第1页前10个可视化作业为例。
GET https://endpoint/v1/{project_id}/visualization-jobs ?status=7&per_page=10&page=1&sortBy=status&order=asc& search_content=job_name
响应示例
- 成功响应示例
{ "quotas": 100, "is_success": true, "job_total_count": 1, "job_count_limit": 999, "jobs": [ { "job_id": 1, "job_name": "visualization-job", "status": 1, "create_time": 15099239923, "resource_id": "4787c885-e18d-4ef1-aa12-c4ed0c364b27", "duration": 1502323, "job_desc": "This is a visualization job", "service_url": "https://console.huaweicloud.com/modelarts/tensoarbod/xxxx/111", "train_url": "/obs/name/" } ] } - 失败响应示例
{ "is_success": false, "error_message": "error message", "error_code": "ModelArts.0103" }
状态码
状态码请参见表1。
