GetInstanceMetrics
Retrieves monitoring data for an EAIS Jupyter instance. The data includes GPU utilization, GPU memory utilization, CPU utilization, and memory utilization.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
eais:GetInstanceMetrics |
get |
*Instance
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
No |
The region ID of the instance. |
cn-beijing |
| InstanceId |
string |
Yes |
The ID of the EAIS instance. |
eais-hznzre6ffmz9num4**** |
| MetricType |
string |
Yes |
The metric type. Valid values:
|
MemoryUsage |
| StartTime |
string |
No |
The start time of the query. The default value is one hour before the current time. Both UNIX timestamps and time strings are supported. Time strings must be in UTC and in the yyyy-MM-ddTHH:mm:SSZ format. |
2022-11-22T16:00:00Z |
| EndTime |
string |
No |
The end time of the query. The default value is the current time. Both UNIX timestamps and time strings are supported. Time strings must be in UTC and in the yyyy-MM-ddTHH:mm:SSZ format. |
2022-11-22T16:30:00Z |
| TimeStep |
string |
No |
The time step size. The default value is 5m. Valid units:
If a unit is not specified, seconds (s) is used by default. |
5m |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
The request ID. |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
| InstanceId |
string |
The ID of the EAIS instance. |
eais-bj8b53it29hfhj****** |
| PodMetrics |
array<object> |
A list of pod metrics. |
|
|
array<object> |
The pod metrics. |
||
| PodId |
string |
The pod ID. |
eais-hznzre6ffmz9num4****-579b587ddf-9txr6 |
| Metrics |
array<object> |
A list of metric data. |
|
|
object |
The metric data. |
||
| Time |
string |
The timestamp. Unit: milliseconds. |
1669107528450 |
| Value |
string |
The utilization percentage. The value is between 0 and 100. |
4.536552540058814 |
Examples
Success response
JSON format
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"InstanceId": "eais-bj8b53it29hfhj******",
"PodMetrics": [
{
"PodId": "eais-hznzre6ffmz9num4****-579b587ddf-9txr6",
"Metrics": [
{
"Time": "1669107528450",
"Value": "4.536552540058814"
}
]
}
]
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.