ListTrainingJobInstanceMetrics - 获取训练任务实例监控指标_人工智能平台 PAI(PAI)-阿里云帮助中心

获取训练任务实例的监控指标。

调试

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

授权信息

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

请求语法

GET /api/v1/trainingjobs/{TrainingJobId}/instancemetrics HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
TrainingJobId	string	是	训练任务 ID。	trains930928remn
MetricType	string	是	指标类型： GpuCoreUsage：POD GPU 使用率 GpuMemoryUsage：POD GPU Memory 使用率 CpuCoreUsage：POD CPU 使用率 MemoryUsage：POD Memory 使用率 NetworkInputRate：POD 网络写入速率 (TCPIP) (MB/s) NetworkOutputRate：POD 网络写出速率 (TCPIP) (MB/s) DiskReadRate：POD 磁盘读取速率（MB/s） DiskWriteRate：POD 磁盘写入速率 (MB/s)	GpuCoreUsage
TimeStep	string	否	时间间隔，可选值： 1h 30m 5m 10s	10s
InstanceId	string	否	实例 ID。	trains930928remn-master-0
StartTime	string	否	起始 UTC 时间，格式 iso8601，假如为空是任务开始时间。	2020-11-08T16:00:00Z
EndTime	string	否	截止 UTC 时间，格式 iso8601，假如为空是当前时间。	2020-11-08T16:00:00Z

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	F082BD0D-21E1-5F9B-81A0-AB07485B03CD
InstanceMetrics	array<object>	所有符合过滤条件的监控指标列表。
InstanceMetrics	object	符合过滤条件的监控指标。
InstanceId	string	实例 ID。	trainkxen7qjyg6y-master-0
Metrics	array<object>	实例监控指标列表。
Metrics	object	实例监控指标。
Time	string	UTC 时间，格式 iso8601。	2020-11-08T16:00:00Z
Value	double	指标值。	1
NodeName	string	节点名称。	trains930928remn-master-0

示例

正常返回示例

JSON格式

{
  "RequestId": "F082BD0D-21E1-5F9B-81A0-AB07485B03CD",
  "InstanceMetrics": [
    {
      "InstanceId": "trainkxen7qjyg6y-master-0",
      "Metrics": [
        {
          "Time": "2020-11-08T16:00:00Z",
          "Value": 1
        }
      ],
      "NodeName": "trains930928remn-master-0"
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-08-06	OpenAPI 返回结构发生变更	查看变更详情