GetInstanceMetrics

Updated at:

Retrieves monitoring data for an EAIS Jupyter instance. The data includes GPU utilization, GPU memory utilization, CPU utilization, and memory utilization.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

eais:GetInstanceMetrics

get

*Instance

acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}

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:

  • GpuCoreUsage: GPU utilization

  • GpuMemoryUsage: GPU memory utilization

  • CpuCoreUsage: CPU utilization

  • MemoryUsage: Memory utilization

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:

  • h: hour

  • m: minute

  • s: second

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.