ListTrainingJobInstanceMetrics-阿里云帮助中心

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
TrainingJobId	string	Yes	Training job ID.	trains930928remn

Request parameters

Parameter	Type	Required	Description	Example
MetricType	string	Yes	Metric type: GpuCoreUsage: POD GPU usage GpuMemoryUsage: POD GPU memory usage CpuCoreUsage: POD CPU usage MemoryUsage: POD memory usage NetworkInputRate: POD network input rate (TCP/IP) (MB/s) NetworkOutputRate: POD network output rate (TCP/IP) (MB/s) DiskReadRate: POD disk read rate (MB/s) DiskWriteRate: POD disk write rate (MB/s)	GpuCoreUsage
TimeStep	string	No	Time interval. Valid values: 1h, 30m, 5m, 10s.	10s
InstanceId	string	No	Instance ID.	trains930928remn-master-0
StartTime	string	No	Start time in UTC, in ISO 8601 format. If empty, use the job start time.	2020-11-08T16:00:00Z
EndTime	string	No	End time in UTC, in ISO 8601 format. If empty, use the current time.	2020-11-08T16:00:00Z

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Request ID.	F082BD0D-21E1-5F9B-81A0-AB07485B03CD
InstanceMetrics	array<object>	List of all monitoring metrics that match the filter condition.
	array<object>	Monitoring metrics that match the filter condition.
InstanceId	string	Instance ID.	trainkxen7qjyg6y-master-0
Metrics	array<object>	List of instance monitoring metrics.
	object	Instance monitoring metric.
Time	string	UTC time in ISO 8601 format.	2020-11-08T16:00:00Z
Value	number	Metric value.	1
NodeName	string	Node name.	trains930928remn-master-0

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.