# 查询训练作业指定任务的运行指标 - ShowTrainingJobMetrics #### 功能介绍 查询训练作业指定任务的运行指标接口用于获取ModelArts平台上指定训练作业任务的运行指标。 该接口适用于以下场景：当用户需要查看特定训练任务的性能指标时，可以通过此接口获取运行指标。使用该接口的前提条件是用户已知训练作业ID和任务ID，并具有查看运行指标的权限。查询操作完成后，平台将返回包含任务的性能指标信息。若训练作业ID或任务ID不存在、任务未生成指标或用户无权限操作，接口将返回相应的错误信息。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ModelArts/doc?api=ShowTrainingJobMetrics)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-modelarts/modelarts_03_0138.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | modelarts:trainJob:get | Read | trainJob \* | g:ResourceTag/\ | - | - | | modelarts:trainJob:get | Read | - | - modelarts:poolType - modelarts:poolId | - | - | #### URI GET /v2/{project_id}/training-jobs/{training_job_id}/metrics/{task_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释** ：用户项目ID。获取方法请参见[获取项目ID和名称](https://support.huaweicloud.com/api-modelarts/modelarts_03_0147.html)。 **约束限制**：不涉及。 **取值范围**：1 - 64字符，字母、数字和中划线。 **默认取值**：不涉及。 | | training_job_id | 是 | String | **参数解释** ：训练作业ID。获取方法请参见[查询训练作业列表](https://support.huaweicloud.com/api-modelarts/ListTrainingJobs.html#ZH-CN_TOPIC_0000002723741806)。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | | task_id | 是 | String | **参数解释**：训练作业的任务ID。可从训练作业详情中的status.tasks字段中获取。 **约束限制**：不涉及。 **取值范围**：单节点默认为"worker-0"，多节点则为"worker-0"、"worker-1"，依次类推。 **默认取值**：不涉及。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表2响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | metrics | Array of [MetricObject] objects | **参数解释**：运行指标。 | 表3MetricObject | 参数 | 参数类型 | 描述 | |:---|:---|:---| | metric | String | **参数解释**：运行指标。 **取值范围**：可选值如下： - cpuUsage：CPU使用率 - memUsage：物理内存使用率 - gpuUtil：GPU使用率 - gpuMemUsage：显存使用率 - npuUtil：NPU使用率 - npuMemUsage：NPU显存使用率 | | value | Array of doubles | **参数解释**：运行指标对应数值，1min统计一个平均值。 | #### 请求示例 如下以查询uuid为2cd88daa-31a4-40a8-a58f-d186b0e93e4f的训练作业对应worker-0运行指标为例 ``` GET https://{endpoint}/v2/{project_id}/training-jobs/2cd88daa-31a4-40a8-a58f-d186b0e93e4f/metrics/worker-0 ``` #### 响应示例 **状态码：200** ``` { "metrics" : [ { "metric" : "cpuUsage", "value" : [ -1, -1, 2.43, 4.524, 6.714, 12.422, 9.214, 5.36, 7.5, 10.088, 8.975, 11.423, 11.548, 14.563, 16.833 ] }, { "metric" : "memUsage", "value" : [ -1, -1, 0.04, 0.521, 1.652, 4.252, 6.433, 7.384, 7.982, 8.718, 9.365, 9.881, 10.192, 9.994, 9.005 ] }, { "metric" : "gpuUtil", "value" : [ -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1 ] }, { "metric" : "gpuMemUsage", "value" : [ -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1 ] }, { "metric" : "npuUtil", "value" : [ -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1 ] }, { "metric" : "npuMemUsage", "value" : [ -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1 ] } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | ok | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-modelarts/modelarts_03_0095.html)。