# 查询资源池作业列表 - ListWorkloads #### 功能介绍 查询专属资源池作业列表接口用于获取指定专属资源池中的作业信息列表。该接口适用于以下场景：当需要监控专属资源池的资源使用情况、查看作业状态或管理资源分配时，用户可通过此接口获取专属资源池中作业的详细信息。使用该接口的前提条件是专属资源池已存在且用户具有相应的权限（如管理员权限或资源管理权限）。调用接口成功后，系统将返回专属资源池中作业的列表，包括作业ID、名称、状态、资源使用情况等详细信息。若专属资源池不存在、用户无权限操作或资源池当前不可用，接口将返回相应的错误信息。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ModelArts/doc?api=ListWorkloads)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-modelarts/modelarts_03_0138.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | modelarts:pool:get | Read | pool \* | g:ResourceTag/\ | - | - | | modelarts:pool:get | Read | - | g:EnterpriseProjectId | - | - | #### URI GET /v2/{project_id}/pools/{pool_name}/workloads 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释** ：用户项目ID，获取方法请参见[获取项目ID和名称](https://support.huaweicloud.com/api-modelarts/modelarts_03_0147.html)。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | pool_name | 是 | String | **参数解释**：资源池的ID，取值自资源池详情的metadata.name字段。 **约束限制**：不涉及。 **取值范围**：只能以小写字母开头，数字、中划线组成，不能以中划线结尾，且长度为\[36-63\]个字符。 **默认取值**：不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | hostip | 否 | Array of strings | **参数解释**：节点IP地址，用于过滤在该节点上运行的workload。支持多个IP，传递多个参数或用逗号分隔. **约束限制**：指定此参数时，不支持分页（limit/offset会被忽略）。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | type | 否 | String | **参数解释**：根据作业类型查询资源池作业列表。 **约束限制**：不涉及。 **取值范围**：可选值如下： - train：训练作业 - infer：推理服务 - notebook：Notebook作业 - x-infer：新版推理作业 **默认取值**：不涉及。 | | userName | 否 | String | **参数解释**：根据用户创建者查询资源池作业列表。支持多个用户名，传递多个用户名参数或用逗号分隔. **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | status | 否 | String | **参数解释**：根据作业状态查询资源池作业列表。 **约束限制**：不涉及。 **取值范围**：可选值如下： - Queue：排队中的作业。 - Pending：等待中的作业。 - Abnormal：异常的作业。 - Terminating：中止中的作业。 - Creating：创建中的作业。 - Running：运行中的作业。 - Completed：已完成的作业。 - Terminated：已终止的作业。 - Failed：运行失败的作业。 **默认取值**：不涉及。 | | sort | 否 | String | **参数解释**：查询资源池作业列表的排序条件。 **约束限制**：不涉及。 **取值范围**：可选值如下： - create_time：根据作业创建时间排序。 **默认取值**：不涉及。 | | ascend | 否 | Boolean | **参数解释**：指定查询资源池作业列表是否按照升序排序。 **约束限制**：需要配合sort查询参数使用。 **取值范围**：可选值如下： - true：按照升序排序。 - false：按照降序排序。 **默认取值**：false。 | | offset | 否 | String | **参数解释**：分页查询的偏移量。 **约束限制**：不涉及。 **取值范围**：0-2147483647。 **默认取值**：0。 | | limit | 否 | Integer | **参数解释**：分页单次查询返回的资源数量。 **约束限制**：不涉及。 **取值范围**：0 - 500。 **默认取值**：500。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | apiVersion | String | **参数解释**：资源的API版本。 **取值范围**：可选值如下： - v1：当前资源版本为v1 | | kind | String | **参数解释**：资源的类型。 **取值范围**：可选值如下： - WorkloadList：作业列表 | | items | Array of [Workload] objects | **参数解释**：资源池中的作业列表。 | 表4Workload | 参数 | 参数类型 | 描述 | |:---|:---|:---| | apiVersion | String | **参数解释**：资源的API版本。 **取值范围**：可选值如下： - v1：当前资源版本为v1 | | kind | String | **参数解释**：资源的类型。 **取值范围**：可选值如下： - Workload：资源池作业 | | type | String | **参数解释**：资源池中作业的业务类型。 **取值范围**：可选值如下： - train：训练作业 - infer：推理服务 - notebook：Notebook作业 - x-infer：新版推理作业 | | namespace | String | **参数解释**：集群中作业所属的命名空间。 **取值范围**：不涉及。 | | name | String | **参数解释**：作业的名称。 **取值范围**：不涉及。 | | jobName | String | **参数解释**：作业的归属的上层业务的名称。 **取值范围**：不涉及。 | | uid | String | **参数解释**：作业的ID。 **取值范围**：不涉及。 | | jobUUID | String | **参数解释**：作业的归属的上层业务的ID。 **取值范围**：不涉及。 | | flavor | String | **参数解释**：作业的资源规格。 **取值范围**：不涉及。 | | status | String | **参数解释**：作业状态。 **取值范围**：不涉及。 | | userName | String | **参数解释**：作业创建者。 **取值范围**：不涉及。 | | resourceRequirement | [resourceRequirement] object | **参数解释**：作业运行请求的资源量。 | | priority | String | **参数解释**：作业的优先级。 **取值范围**：不涉及。 | | runningDuration | Integer | **参数解释**：作业的运行时长，以秒为单位。 **取值范围**：不涉及。 | | pendingDuration | Integer | **参数解释**：作业的排队时长，以秒为单位。 **取值范围**：不涉及。 | | pendingPosition | Integer | **参数解释**：作业当前的排队位置。 **取值范围**：不涉及。 | | createTime | Integer | **参数解释**：作业的Unix创建时间戳，以毫秒为单位。 **取值范围**：不涉及。 | | gvk | String | **参数解释**：作业的k8s资源类型、分组和版本。 **取值范围**：不涉及。 | | hostIps | String | **参数解释**：作业运行的节点IP列表，以","分隔。 **取值范围**：不涉及。 | | nodes | Array of [WorkloadNodeVO] objects | **参数解释**：作业运行时占用的节点资源信息。 | 表5resourceRequirement | 参数 | 参数类型 | 描述 | |:---|:---|:---| | cpu | String | **参数解释**：作业的运行使用的CPU资源量。 **取值范围**：不涉及。 | | memory | String | **参数解释**：作业的运行使用的内存资源量。 **取值范围**：不涉及。 | | nvidia.com/gpu | String | **参数解释**：作业的运行使用的GPU资源量。 **取值范围**：不涉及。 | | huawei.com/ascend-310 | String | **参数解释**：作业的运行使用的snt3类型NPU资源量。 **取值范围**：不涉及 | | huawei.com/ascend-1980 | String | **参数解释**：作业的运行使用的snt9类型NPU资源量。 **取值范围**：不涉及。 | 表6WorkloadNodeVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | hostIp | String | **参数解释**：作业运行节点的IP地址。 **取值范围**：不涉及。 | | npuTopologyPlacement | String | **参数解释**：NPU卡的资源使用拓扑信息，长度为16的二进制编码，右起第一位编码代表卡1。其中，1表示占用，0表示空闲。例如，16卡的机型中卡1和卡15被占用，值为0100000000000001；8卡的机型中卡1和卡7被占用，返回值为0000000001000001。 **取值范围**：不涉及。 | | resourceRequirement | [ResourceRequirementVO] object | **参数解释**：作业的运行使用的资源量。 | 表7ResourceRequirementVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | cpu | String | **参数解释**：作业的运行使用的CPU资源量。 **取值范围**：不涉及。 | | memory | String | **参数解释**：作业的运行使用的内存资源量。 **取值范围**：不涉及。 | | nvidia.com/gpu | String | **参数解释**：作业的运行使用的GPU资源量。 **取值范围**：不涉及。 | | huawei.com/ascend-310 | String | **参数解释**：作业的运行使用的snt3类型NPU资源量。 **取值范围**：不涉及。 | | huawei.com/ascend-1980 | String | **参数解释**：作业的运行使用的snt9类型NPU资源量。 **取值范围**：不涉及。 | **状态码：400** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**：ModelArts错误码。 **取值范围**：不涉及。 | | error_msg | String | **参数解释**：具体错误信息。 **取值范围**：不涉及。 | **状态码：404** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**：ModelArts错误码。 **取值范围**：不涉及。 | | error_msg | String | **参数解释**：具体错误信息。 **取值范围**：不涉及。 | #### 请求示例 ``` GET https://{endpoint}/v2/{project_id}/pools/{pool_name}/workloads ``` #### 响应示例 **状态码：200** OK。 ``` { "kind" : "WorkloadList", "apiVersion" : "v1", "items" : [ { "kind" : "Workload", "apiVersion" : "v1", "uid" : "837ad51b-7c39-41f7-82e9-ea904cbb8ed6", "jobUUID" : "19d05662-0f87-43c7-8426-1ccf4b30179b", "name" : "ma-job-19d05662-0f87-43c7-8426-1ccf4b30179b", "jobName" : "DI-job-202412022313-hlyh5", "type" : "train", "namespace" : "os-pool-train-dSnt9b-memarts1-1ccf4b30179b", "status" : "Running", "resourceRequirement" : { "cpu" : "360 Cores", "memory" : "2.36 TiB" }, "priority" : "1", "createTime" : 1733152598000, "runningDuration" : 1857065, "pendingPosition" : -1, "gvk" : "batch.volcano.sh/v1alpha1, Kind=Job", "userName" : "wangt", "hostIps" : "192.168.81.93,192.168.73.217", "nodes" : [ { "hostIp" : "192.168.81.93", "npuTopologyPlacement" : "0x00ff", "resourceRequirement" : { "cpu" : "180 Cores", "memory" : "1.18 TiB", "huawei.com/ascend-1980" : "8" } }, { "hostIp" : "192.168.73.217", "npuTopologyPlacement" : "0x00ff", "resourceRequirement" : { "cpu" : "180 Cores", "memory" : "1.18 TiB", "huawei.com/ascend-1980" : "8" } } ] } ] } ``` **状态码：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。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-modelarts/modelarts_03_0095.html)。