# 查询专属资源池作业统计信息 - ShowWorkloadStatistics #### 功能介绍 查询专属资源池作业统计信息接口用于获取指定专属资源池中作业的统计信息。该接口适用于以下场景：当需要了解专属资源池中作业的整体运行情况、资源使用效率或作业状态分布时，用户可通过此接口获取统计信息。使用该接口的前提条件是专属资源池已存在且用户具有相应的权限（如管理员权限或资源管理权限）。调用接口成功后，系统将返回专属资源池中作业的统计信息，包括作业总数、运行中作业数、完成作业数、资源使用率等数据。若专属资源池不存在、用户无权限操作或资源池当前不可用，接口将返回相应的错误信息。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ModelArts/doc?api=ShowWorkloadStatistics)中调试该接口，支持自动认证鉴权。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}/statistics/pools/{pool_name}/workloads 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释** ：用户项目ID。获取方法请参见[获取项目ID和名称](https://support.huaweicloud.com/api-modelarts/modelarts_03_0147.html)。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | pool_name | 是 | String | **参数解释**：作业所属的资源池。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表2响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | statistics | [statistics] object | **参数描述**：作业的统计信息。 | 表3statistics | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | **参数描述**：统计信息列表数量。 **取值范围**：不涉及。 | | items | Array of [WorkloadStatistics] objects | **参数描述**：特定作业类型统计信息。 | 表4WorkloadStatistics | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | **参数描述**： 作业类型。 **取值范围**： 可选值如下： - train：训练作业 - infer：推理作业 - notebook：Notebook作业 | | total | Integer | **参数描述**： 作业个数。 **取值范围**： 不涉及。 | | status | [status] object | **参数描述**：不同状态下作业个数。 | 表5status | 参数 | 参数类型 | 描述 | |:---|:---|:---| | Queue | Integer | **参数描述**： 排队中的作业个数。 **取值范围**： 不涉及。 | | Pending | Integer | **参数描述**： 等待中的作业个数。 **取值范围**： 不涉及。 | | Abnormal | Integer | **参数描述**： 异常的作业个数。 **取值范围**： 不涉及。 | | Terminating | Integer | **参数描述**： 终止中的作业个数。 **取值范围**： 不涉及。 | | Creating | Integer | **参数描述**： 创建中的作业个数。 **取值范围**： 不涉及。 | | Running | Integer | **参数描述**： 运行中的作业个数。 **取值范围**： 不涉及。 | | Completed | Integer | **参数描述**： 已完成的作业个数。 **取值范围**： 不涉及。 | | Terminated | Integer | **参数描述**： 已终止的作业个数。 **取值范围**： 不涉及。 | | Failed | Integer | **参数描述**：运行失败的作业个数。 **取值范围**： 不涉及。 | **状态码：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}/statistics/pools/{pool_name}/workloads ``` #### 响应示例 **状态码：200** 无 **状态码：400** ``` { "error_code" : "ModelArts.50004000", "error_msg" : "Bad request." } ``` **状态码：404** ``` { "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)。