Query fine-grained disk monitoring data using DescribeDiskMonitorData - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Queries fine-grained monitoring data of a disk.

Operation description

Usage notes

CloudLens for EBS is in invitational preview in the China (Hangzhou), China (Shanghai), China (Zhangjiakou), China (Shenzhen), and China (Hong Kong) regions. To use the feature, submit a ticket.
Up to 400 monitoring data entries can be returned at a time. An error is returned if the value calculated based on the following formula is greater than 400: (EndTime - StartTime)/Period.
You can query the monitoring data collected in the last three days. An error is returned if the time specified by StartTime is more than three days prior to the current time.

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

ebs:DescribeDiskMonitorData

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the disk.	cn-hangzhou
DiskId	string	Yes	The ID of the disk.	d-bp67acfmxazb4p****
StartTime	string	Yes	The beginning of the time range during which you want to query the near real-time monitoring data of the disk. Specify the time in the ISO 8601 standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time must be in UTC.	2022-06-01T03:00:00Z
EndTime	string	Yes	The end of the time range during which you want to query the near real-time monitoring data of the disk. Specify the time in the ISO 8601 standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time must be in UTC.	2022-06-01T05:00:00Z
Period	integer	No	The interval at which the near real-time monitoring data is collected. Unit: seconds. Valid values: 5 60 Default value: 5.	5
Type	string	No	The type of the monitoring data. Valid values: basic: baseline performance data. pro: burst performance data, such as burst I/O operations.	basic

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
TotalCount	integer	The total number of entries returned.	15
MonitorData	array<object>	The near real-time monitoring data of the disk.
	object	The near real-time monitoring data of the disk.
ReadBPS	integer	The read bandwidth of the disk. Unit: MByte/s.	10
WriteBPS	integer	The write bandwidth of the disk. Unit: MByte/s.	204
DiskId	string	The ID of the disk.	d-bp1bq5g3dxxo1x4o****
ReadIOPS	integer	The maximum number of read IOPS.	2000
WriteIOPS	integer	The maximum number of write IOPS.	2000
IOPSPercent	integer	The percentage of IOPS.	80(%)
BPSPercent	integer	The percentage of BPS.	80(%)
Timestamp	string	The timestamp that is used to query the near real-time monitoring data of the disk. The time follows the ISO 8601 standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.	2022-06-01T08:00:00Z
BurstIOCount	integer	The number of burst I/O operations.	0
ReadBlockSize	integer	Read IO block size. Unit: Bytes	4096
WriteBlockSize	integer	Write IO block size. Unit: Bytes	4096
ReadLatency	integer	Read IO latency. Unit: microsecond	100
WriteLatency	integer	Write IO latency. Unit: microsecond	100

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "TotalCount": 15,
  "MonitorData": [
    {
      "ReadBPS": 10,
      "WriteBPS": 204,
      "DiskId": "d-bp1bq5g3dxxo1x4o****",
      "ReadIOPS": 2000,
      "WriteIOPS": 2000,
      "IOPSPercent": 0,
      "BPSPercent": 0,
      "Timestamp": "2022-06-01T08:00:00Z",
      "BurstIOCount": 0,
      "ReadBlockSize": 4096,
      "WriteBlockSize": 4096,
      "ReadLatency": 100,
      "WriteLatency": 100
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	An internal error has occurred.
403	Forbidden	User is not authorized to operate.	You are not authorized to manage the resource. Check the account permissions or contact the Alibaba Cloud account.
403	Forbidden.Action	User is not authorized to operate this action.	You are not authorized to perform this operation. Check the account permissions or contact the Alibaba Cloud account.
404	NoSuchResource	The specified resource does not exist.	The specified resource does not exist.
504	RequestTimeout	The request is timeout, please try again later.	The request has timed out. Try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.