GetInstanceMetrics-阿里云帮助中心

Queries the resource metrics of an instance.

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

paidsw:GetInstanceMetrics

get

*All Resource

*

None

Request syntax

GET /api/v2/instance/{InstanceId}/metrics HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID. You can call ListInstances to obtain the instance ID.	dsw-730xxxxxxxxxx

Request parameters

Parameter	Type	Required	Description	Example
MetricType	string	Yes	The metric type. Valid values: GpuCoreUsage: the GPU utilization. GpuMemoryUsage: the GPU memory utilization. CpuCoreUsage: the CPU utilization. MemoryUsage: the memory utilization. NetworkInputRate: the network ingress rate. NetworkOutputRate: the network egress rate. DiskReadRate: the disk read rate. DiskWriteRate: the disk write rate. Valid values: GpuCoreUsage : NetworkInputRate : DiskWriteRate : CpuCoreUsage : GpuMemoryUsage : NetworkOutputRate : DiskReadRate : MemoryUsage :	GpuCoreUsage
StartTime	string	No	The beginning of the time range to query.	2020-11-08T15:00:00Z
EndTime	string	No	The end of the time range to query.	2020-11-08T15:00:00Z
TimeStep	string	No	The interval at which metrics are returned. Unit: minutes.	15m

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	E7D55162-4489-1619-AAF5-3F97D5FCA948
Success	boolean	Indicates whether the request was successful. true false	true
Message	string	The response message.	"XXX"
Code	string	The status code. Valid values: InternalError: an internal error. All errors, except for parameter validation errors, are classified as internal errors. ValidationError: a parameter validation error.	null
HttpStatusCode	integer	The HTTP status code. Valid values: 400 404	null
InstanceId	string	The instance ID.	dsw-730xxxxxxxxxx
PodMetrics	array<object>	The information about the metrics of the pod that corresponds to the instance.
	array<object>	The information about the metric of the pod that corresponds to the instance.
PodId	string	The ID of the pod that corresponds to the instance.	dsw-15870-695f44c5bc-hd6xm
Metrics	array<object>	The metrics of the pod that corresponds to the instance.
	object	The metric of the pod that corresponds to the instance.
Time	integer	The timestamp corresponding to the metric.	1670890560
Value	number	The metric value.	25.901031

Examples

Success response

JSON format

{
  "RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
  "Success": true,
  "Message": "\"XXX\"",
  "Code": "null",
  "HttpStatusCode": 0,
  "InstanceId": "dsw-730xxxxxxxxxx",
  "PodMetrics": [
    {
      "PodId": "dsw-15870-695f44c5bc-hd6xm",
      "Metrics": [
        {
          "Time": 1670890560,
          "Value": 25.901031
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.