首页 机器学习PAI API参考 PAI-DLC API API目录 任务 GetJobMetrics - 获取任务的监控数据

GetJobMetrics - 获取任务的监控数据

获取一个任务的监控数据,包括CPU、GPU、Memory的使用率、Network、Disk读写速率等。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
JobIdstring

任务ID。您可以调用ListJobs获取所有任务的ID。

dlc-20210126170216-*******
StartTimestring

查询监控数据的时间区间的起始时间,默认值是1小时前。

2020-11-08T16:00:00Z
EndTimestring

查询监控数据的时间区间的截止时间,默认值是当前。

2020-11-09T16:00:00Z
TimeStepstring

返回监控数据的时间间隔,默认值是5分钟。

5m
MetricTypestring

查询监控数据的指标类型,枚举:

  • GpuCoreUsage:GPU使用率

  • GpuMemoryUsage:GPU Memory使用率

  • CpuCoreUsage:CPU使用率

  • MemoryUsage:Memory使用率

  • NetworkInputRate:网络写入速率

  • NetworkOutputRate:网络写出速率

  • DiskReadRate:磁盘读取速率

  • DiskWriteRate:磁盘写入速率

GpuMemoryUsage
Tokenstring

返回参数

名称类型描述示例值
object

任务监控数据信息。

JobIdstring

任务ID。

dlc-20210126170216-*******
PodMetricsarray

任务监控数据列表。

PodMetric

任务监控数据。

RequestIdstring

本次调用的请求ID,用于诊断和答疑。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

示例

正常返回示例

JSON格式

{
  "JobId": "dlc-20210126170216-*******",
  "PodMetrics": [
    {
      "PodId": "dlc-20210329110128-746bf7cl47pr8-worker-0",
      "Metrics": [
        {
          "Time": 1616987726587,
          "Value": 23.45
        }
      ]
    }
  ],
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2021-04-23新增 OpenAPI
阿里云首页 机器学习PAI 相关技术圈