文档首页> AI开发平台ModelArts> API参考> 资源管理> 查询专属资源池作业列表
更新时间:2024-05-30 GMT+08:00

查询专属资源池作业列表

功能介绍

查询专属资源池作业列表。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/pools/{pool_name}/workloads

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

用户项目ID。获取方法请参见获取项目ID和名称

pool_name

String

作业所属的命名空间。

表2 Query参数

参数

是否必选

参数类型

描述

type

String

作业所属业务。可选值如下:

  • train:训练作业

  • infer:推理服务

  • notebook:Notebook作业

status

String

作业状态。可选值如下:

  • Queue:排队中

  • Pending:等待中

  • Abnormal:异常

  • Terminating:中止中

  • Creating:创建中

  • Running:运行中

  • Completed:已完成

  • Terminated:已终止

  • Failed:运行失败

sort

String

排序依据字段。可选值:

  • create_time:根据作业创建时间排序

ascend

Boolean

是否按照升序排序。

offset

String

分页查询,起始位置。

limit

Integer

单页查询最大数量,值为空或者0时默认为500,最大值为500。

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

apiVersion

String

API版本。可选值如下:

  • v1

kind

String

资源类型。可选值如下:

  • WorkloadList:作业列表

items

Array of Workload objects

作业列表。

表4 Workload

参数

参数类型

描述

apiVersion

String

资源版本。可选值如下:

  • v1

kind

String

资源类型,可选值如下:

  • Workload

type

String

作业所属业务类型。可选值如下:

  • train:训练作业

namespace

String

作业所属资源池名称。

name

String

作业名称。

jobName

String

上层业务作业名称。

uid

String

作业uid。

jobUUID

String

上层业务作业id。

flavor

String

作业规格。

status

String

作业状态。

resourceRequirement

resourceRequirement object

运行作业的资源请求量。

priority

String

作业优先级。

runningDuration

Integer

作业运行时长。

pendingDuration

Integer

作业排队时长。

pendingPosition

Integer

作业排队位置。

createTime

Integer

作业创建时间。

gvk

String

作业的k8s资源类型、分组和版本。

hostIps

String

作业运行的节点IP列表,逗号分隔。

表5 resourceRequirement

参数

参数类型

描述

cpu

String

CPU使用量。

memory

String

内存使用量。

nvidia.com/gpu

String

GPU资源使用量。

huawei.com/ascend-snt3

String

昇腾资源使用量。

huawei.com/ascend-snt9

String

昇腾资源使用量。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

ModelArts错误码。

error_msg

String

具体错误信息。

状态码: 404

表7 响应Body参数

参数

参数类型

描述

error_code

String

ModelArts错误码。

error_msg

String

具体错误信息。

请求示例

GET https://{endpoint}/v2/{project_id}/pools/{pool_name}/workloads

响应示例

状态码: 400

Bad Request。

{
  "error_code" : "ModelArts.50004000",
  "error_msg" : "Bad request."
}

状态码: 404

Not Found。

{
  "error_code" : "ModelArts.50015001",
  "error_msg" : "Pool {name} not found."
}

状态码

状态码

描述

200

OK。

400

Bad Request。

404

Not Found。

错误码

请参见错误码