DescribeDiskMonitorData - Elastic Compute Service - Alibaba Cloud Documentation Center

Queries the monitoring data of a disk over a specific period of time.

Description

The monitoring data includes read IOPS, write IOPS, read bandwidth (byte/s), write bandwidth (byte/s), read latency (μs), and write latency (μs) of the disk.

When you call this operation, take note of the following items:

You can query the monitoring data only of the disks that are in the In Use (In_Use) state. For more information, see Disk states.
Note Some information may be missing from the monitoring data of a disk because the disk is not in the In Use (In_Use) state and the system cannot obtain the relevant information.
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 in the previous 30 days. If the value of StartTime is more than 30 days before the current time, an error is returned.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeDiskMonitorData	The operation that you want to perform. Set the value to DescribeDiskMonitorData.
DiskId	String	Yes	d-bp1bq5g3dxxo1x4o****	The ID of the disk.
StartTime	String	Yes	2014-07-23T12:07:00Z	The beginning of the time range in which to query the monitoring data. 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 rounded up to the next minute.
EndTime	String	Yes	2014-07-23T12:09:00Z	The end of the time range in which to query the monitoring data. 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 rounded up to the next minute.
Period	Integer	No.	60	The interval at which to retrieve the monitoring data. Unit: seconds. Valid values: 60 600 3600 Default value: 60.

Response parameters


Parameter	Type	Example	Description
TotalCount	Integer	3	The total number of returned monitoring data entries.
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	The ID of the request.
MonitorData	Array of DiskMonitorData		Details about the monitoring data of the disk.
DiskMonitorData
BPSRead	Integer	0	The read bandwidth of the system disk. Unit: byte/s.
IOPSRead	Integer	0	The number of read I/O operations per second on the system disk.
LatencyRead	Integer	0	The read latency of the disk. Unit: microseconds.
BPSTotal	Integer	204	The total read and write bandwidth of the system disk. Unit: byte/s.
IOPSTotal	Integer	0	The total number of read and write I/O operations per second on the system disk.
TimeStamp	String	2014-07-23T12:07:00Z	The timestamp to query the monitoring data. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
LatencyWrite	Integer	0	The write latency of the disk. Unit: microseconds.
IOPSWrite	Integer	0	The number of write I/O operations per second on the system disk.
DiskId	String	d-bp1bq5g3dxxo1x4o****	The ID of the disk.
BPSWrite	Integer	204	The write bandwidth of the system disk. Unit: byte/s.

Examples

Sample requests

https://ecs.aliyuncs.com/?Action=DescribeDiskMonitorData
&DiskId=d-bp1bq5g3dxxo1x4o****
&EndTime=2014-07-23T12:09:00Z
&StartTime=2014-07-23T12:07:00Z
&Period=60
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDiskMonitorDataResponse>
        <MonitorData>
                <DiskMonitorData>
                        <BPSRead>0</BPSRead>
                        <BPSTotal>0</BPSTotal>
                        <BPSWrite>0</BPSWrite>
                        <DiskId>d-bp1bq5g3dxxo1x4o****</DiskId>
                        <IOPSRead>0</IOPSRead>
                        <IOPSTotal>0</IOPSTotal>
                        <IOPSWrite>0</IOPSWrite>
                        <TimeStamp>2014-07-23T12:07:00Z</TimeStamp>
                </DiskMonitorData>
                <DiskMonitorData>
                        <BPSRead>0</BPSRead>
                        <BPSTotal>204</BPSTotal>
                        <BPSWrite>204</BPSWrite>
                        <DiskId>d-bp1bq5g3dxxo1x4o****</DiskId>
                        <IOPSRead>0</IOPSRead>
                        <IOPSTotal>0</IOPSTotal>
                        <IOPSWrite>0</IOPSWrite>
                        <TimeStamp>2014-07-23T12:08:00Z</TimeStamp>
                </DiskMonitorData>
                <DiskMonitorData>
                        <BPSRead>0</BPSRead>
                        <BPSTotal>819</BPSTotal>
                        <BPSWrite>819</BPSWrite>
                        <DiskId>d-bp1bq5g3dxxo1x4o****</DiskId>
                        <IOPSRead>0</IOPSRead>
                        <IOPSTotal>0</IOPSTotal>
                        <IOPSWrite>0</IOPSWrite>
                        <TimeStamp>2014-07-23T12:09:00Z</TimeStamp>
                </DiskMonitorData>
        </MonitorData>
        <RequestId>BF666447-B171-4076-BCBA-48437C18FD76</RequestId>
        <TotalCount>3</TotalCount>
</DescribeDiskMonitorDataResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "MonitorData" : {
    "DiskMonitorData" : [ {
      "BPSRead" : 0,
      "BPSTotal" : 0,
      "BPSWrite" : 0,
      "DiskId" : "d-bp1bq5g3dxxo1x4o****",
      "IOPSRead" : 0,
      "IOPSTotal" : 0,
      "IOPSWrite" : 0,
      "TimeStamp" : "2014-07-23T12:07:00Z"
    }, {
      "BPSRead" : 0,
      "BPSTotal" : 204,
      "BPSWrite" : 204,
      "DiskId" : "d-bp1bq5g3dxxo1x4o****",
      "IOPSRead" : 0,
      "IOPSTotal" : 0,
      "IOPSWrite" : 0,
      "TimeStamp" : "2014-07-23T12:08:00Z"
    }, {
      "BPSRead" : 0,
      "BPSTotal" : 819,
      "BPSWrite" : 819,
      "DiskId" : "d-bp1bq5g3dxxo1x4o****",
      "IOPSRead" : 0,
      "IOPSTotal" : 0,
      "IOPSWrite" : 0,
      "TimeStamp" : "2014-07-23T12:09:00Z"
    } ]
  },
  "RequestId" : "A48A0A77-34F5-4C33-9066-9E8D2DA0D8E2",
  "TotalCount" : 3
}

Error codes


HTTP status code	Error code	Error message	Description
400	InvalidParameter.TooManyDataQueried	Too many data queried.	The error message returned because the amount of queried monitoring data has reached the upper limit.
400	Throttling	Request was denied due to request throttling.	The error message returned because your request is throttled. Try again later.
400	InvalidInstanceType.NotSupportCredit	The InstanceType of the specified instance does not support credit.	The error message returned because the instance type does not support burstable instances.
400	InvalidParameter.EndTime	The specified parameter EndTime is earlier than StartTime.	The error message returned because the end time cannot be earlier than the start time.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	The error message returned because an internal error has occurred. Try again later.
404	InvalidDiskId.NotFound	The DiskId provided does not exist in our records.	The error message returned because the specified disk does not exist. Check whether the disk ID is correct.

For a list of error codes, see Service error codes.