调用GetJobMetrics获取DLC任务的监控数据,包括GPU使用率、GPU Memory使用率、CPU使用率、Memory使用率、Network写入写出速率和Disk读写速率。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求语法
GET /api/v1/jobs/JobId/metrics?StartTime=String&EndTime=String&TimeStep=String&MetricType=String HTTP/1.1
Content-Type:application/json
请求参数
参数名称 | 类型 | 是否必选 | 示例 | 说明 |
---|---|---|---|---|
JobId | String | 是 | dlc-20210126170216-******* |
任务ID。您可以调用ListJobs获取所有任务的ID。 |
参数名称 | 类型 | 是否必选 | 示例 | 说明 |
---|---|---|---|---|
StartTime | String | 否 | 2020-11-08T16:00:00Z |
查询监控数据的时间区间的起始时间,默认值是1小时前。 |
EndTime | String | 否 | 2020-11-09T16:00:00Z |
查询监控数据的时间区间的截止时间,默认值是当前。 |
TimeStep | String | 否 | 5m |
返回监控数据的时间间隔,默认值是5分钟。 |
MetricType | String | 是 | GpuMemoryUsage |
查询监控数据的指标类型,枚举:
|
响应体语法
HTTP/1.1 200 OK
Content-Type:application/json
{
"JobId" : "String",
"PodMetrics" : [ {
"PodId" : "String",
"Metrics" : [ {
"Time" : Long,
"Value" : Float
} ]
} ],
"RequestId" : "String"
}
响应参数
参数名称 | 类型 | 示例 | 说明 |
---|---|---|---|
JobId | String | dlc-20210126170216-******* |
任务ID。 |
PodMetrics | Array of PodMetric |
任务监控数据列表。 |
|
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
本次调用的请求ID,用于诊断和答疑。 |
示例1
GET /api/v1/jobs/dlc-20210126170216-*******/metrics?StartTime=2020-11-08T16:00:00Z&EndTime=2020-11-09T16:00:00Z&TimeStep=5m&MetricType=GpuMemoryUsage HTTP/1.1
Host:pai-dlc.aliyuncs.com
Content-Type:application/json
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<GetJobMetricsResponse>
<JobId>dlc-20210126170216-*******</JobId>
<PodMetrics>
<PodId>dlc-20210329110128-******-worker-0</PodId>
<Metrics>
<Time>1616987726587</Time>
<Value>23.45</Value>
</Metrics>
</PodMetrics>
<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
</GetJobMetricsResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"JobId" : "dlc-20210126170216-*******",
"PodMetrics" : [ {
"PodId" : "dlc-20210329110128-******-worker-0",
"Metrics" : [ {
"Time" : 1616987726587,
"Value" : 23.45
} ]
} ],
"RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}
错误码
访问错误中心查看更多错误码。
开发者资源
-
SDK
阿里云为您提供多种语言的SDK,帮助您快速通过API集成阿里云的产品和服务,推荐您使用SDK调用API,已免除您手动签名验证。
-
OpenAPI Explorer
快速检索,可视化调试API,在线命令行工具,同步动态生成可执行的SDK代码示例。
-
阿里云CLI
阿里云资产管理和配置工具,可通过命令方式同时管理多个阿里云产品和服务,简单快捷,是您上云好帮手。