Query instance monitoring data using DescribeInstanceMonitorData - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Queries the monitoring data of an ECS instance. The metrics that you can query include the vCPU utilization, burstable instance credits, inbound data traffic, outbound data traffic, and average bandwidth of the ECS instance.

Operation description

Take note of the following items when you call this operation:

A maximum of 400 data entries can be returned at a time. Make sure that the value of (EndTime – StartTime)/Period is less than or equal to 400. In other words, the value of the TotalCount response parameter cannot exceed 400. Otherwise, the InvalidParameter.TooManyDataQueried error is returned.
You can query monitoring data from the last 30 days. The StartTime parameter value cannot be more than 30 days before the current date.
If some content is missing from the response, the system may not have obtained the corresponding information. For example, the instance was in the Stopped state at that time.
This operation cannot retrieve the basic CPU monitoring data of ECS Bare Metal instances. You can install the CloudMonitor agent to obtain CPU monitoring data. For more information, see Install the CloudMonitor agent.

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

ecs:DescribeInstanceMonitorData

get

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID of the instance to query.	i-bp1a36962lrhj4ab****
StartTime	string	Yes	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. If the value of seconds (`ss`) is not `00`, the time is automatically rounded up to the next minute.	2014-10-29T23:00:00Z
EndTime	string	Yes	The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. If the value of seconds (`ss`) is not `00`, the time is automatically rounded up to the next minute.	2014-10-30T08:00:00Z
Period	integer	No	The interval at which to retrieve monitoring data. Unit: seconds. Valid values: Default value: 60. Valid values: 60 : 60 seconds. 600 : 600 seconds. 3600 : 3600 seconds.	60

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
MonitorData	object
InstanceMonitorData	array<object>	The collection of instance monitoring data.
	object
CPUCreditBalance	number	The total number of burstable instance credits.	120
BPSRead	integer	The read bandwidth of the instance disks (including the system disk and data disks). Unit: bytes/s.	1000
InternetTX	integer	The public outbound data traffic sent by the instance during the specified interval (`Period`) at the time of the query (`TimeStamp`). Unit: kbits.	343
CPU	integer	The vCPU utilization of the instance. Unit: percent (%).	2
CPUCreditUsage	number	The number of burstable instance credits consumed.	30
IOPSWrite	integer	The I/O write operations on the instance disks (including the system disk and data disks). Unit: operations/s.	200
IntranetTX	integer	The internal outbound data traffic sent by the instance during the specified interval (`Period`) at the time of the query (`TimeStamp`). Unit: kbits.	343
InstanceId	string	The instance ID.	i-bp1a36962lrhj4****
BPSWrite	integer	The write bandwidth of the instance disks (including the system disk and data disks). Unit: bytes/s.	13585
CPUNotpaidSurplusCreditUsage	number	The unpaid overdrawn CPU credits.	0.5
CPUAdvanceCreditBalance	number	The overdrawn CPU credits (the portion of burstable instance credits that exceeds the limit).	0.4
IOPSRead	integer	The I/O read operations on the instance disks (including the system disk and data disks). Unit: operations/s.	1000
InternetBandwidth	integer	The public bandwidth of the instance, which is the network traffic per unit of time. Unit: kbits/s.	10
InternetRX	integer	The public inbound data traffic received by the instance during the specified interval (`Period`) at the time of the query (`TimeStamp`). Unit: kbits.	122
TimeStamp	string	The timestamp of the monitoring data.	2014-10-30T05:00:00Z
IntranetRX	integer	The internal inbound data traffic received by the instance during the specified interval (`Period`) at the time of the query (`TimeStamp`). Unit: kbits.	122
IntranetBandwidth	integer	The internal bandwidth of the instance, which is the network traffic per unit of time. Unit: kbits/s.	10

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "MonitorData": {
    "InstanceMonitorData": [
      {
        "CPUCreditBalance": 120,
        "BPSRead": 1000,
        "InternetTX": 343,
        "CPU": 2,
        "CPUCreditUsage": 30,
        "IOPSWrite": 200,
        "IntranetTX": 343,
        "InstanceId": "i-bp1a36962lrhj4****",
        "BPSWrite": 13585,
        "CPUNotpaidSurplusCreditUsage": 0.5,
        "CPUAdvanceCreditBalance": 0.4,
        "IOPSRead": 1000,
        "InternetBandwidth": 10,
        "InternetRX": 122,
        "TimeStamp": "2014-10-30T05:00:00Z",
        "IntranetRX": 122,
        "IntranetBandwidth": 10
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Malformed	The specified parameter "StartTime" is not valid.	The specified StartTime parameter does not conform to the specification.
400	InvalidEndTime.Malformed	The specified parameter "EndTime" is not valid.	The specified EndTime parameter is invalid.
400	InvalidPeriod.ValueNotSupported	The specified parameter "Period" is not valid.
400	InvalidStartTime.TooEarly	The specified parameter "StartTime" is too early.
400	InvalidParameter.TooManyDataQueried	Too many data queried.	The monitoring data node is out of range.
400	Throttling	Request was denied due to request throttling.	The request is throttled.
400	InvalidStartTime.ValueNotSupported	The specified parameter StartTime is later than EndTime.	The specified start time is not within the allowed range.
500	InternalError	The request processing has failed due to some unknown error.
404	InvalidInstanceId.NotFound	The specified InstanceId does not exist.	The specified instanceId is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.