View monitoring information of a disk

Last Updated: Jul 25, 2017

Description

Query the user’s monitoring information related to the specified disk by page.

  • You can only query monitoring information for disks in In_use state.

  • The monitoring information that can be returned includes: Disk read IOPS, disk write IOPS, disk read bandwidth (Bps), disk write bandwidth (Bps), disk read timeout (ms), disk write timeout (ms). Some portion may be missing from the returned monitoring data. This may be due to the fact that the system has not obtained the relevant information, e.g., when a disk is in the In_use state.

  • At one time, up to 60 monitoring data entries can be returned. If the specified (EndTime - StartTime)/ Period > 60, an error is returned.

Request Parameters

Name Type Required Description
Action String Yes Required parameter, with a value: DescribeDiskMonitorData.
DiskId String Yes The specified monitoring disk ID.
StartTime String Yes The start time of the retrieved data: which is represented according to ISO8601, and UTC is required. Format: YYYY-MM-DDThh:mm:ssZ.
If the seconds place is not 00, it is automatically set to start from the next minute.
EndTime String Yes The end time of the retrieved data: which is represented according to ISO8601, and UTC is required. Format: YYYY-MM-DDThh:mm:ssZ.
If the seconds place is not 00, it is automatically set to start from the next minute.
Period Integer No The precision of the retrieved monitoring data:
  • 60 seconds
  • 600 seconds
  • 3600 seconds
The default value is 60 seconds.

Return Parameters

Name Type Description
TotalCount Integer The total number of disk monitoring data entries.
MonitorData DiskMonitorDataType A collection composed of disk monitoring data DiskMonitorDataType.

Error Code

Error Code Description Http status code Meaning
InvalidDiskId.NotFound The DiskId provided does not exist in our records. 404 The specified disk ID does not exist.
MissingParameter The input parameter DiskId that is mandatory for processing this request is not supplied. 400 The DiskId parameter is missing.
InvalidStartTime.Malformed The specified parameter StartTime is not valid. 400 The StartTime format is invalid.
MissingParameter The input parameter StartTime that is mandatory for processing this request is not supplied. 400 The StartTime value is missing.
InvalidEndTime.Malformed The specified parameter EndTime is not valid. 400 The indicated EndTime format is invalid.
MissingParameter The input parameter EndTime that is mandatory for processing this request is not supplied. 400 The EndTime value is missing.
InvalidParameter The specified parameter Period is not valid. 400 The indicated Period is not a number.
InvalidPeriod.ValueNotSupported The specified parameter Period is not valid. 400 The indicated Period format is invalid.
InvalidStartTime.TooEarly The specified parameter StartTime is too early. 400 The indicated StartTime is too early.

Examples

Request Example

  1. https://ecs.aliyuncs.com/?Action=DescribeDiskMonitorData
  2. &DiskId=d-mydisk001
  3. &StartTime=2014-07-23T12:07:00Z
  4. &EndTime=2014-07-23T12:09:00Z
  5. &<Public Request Parameters>

Return Example

XML format

  1. <?xml version="1.0" encoding="utf-8"?>
  2. <DescribeDiskMonitorDataResponse>
  3. <MonitorData>
  4. <DiskMonitorData>
  5. <BPSRead>0</BPSRead>
  6. <BPSTotal>0</BPSTotal>
  7. <BPSWrite>0</BPSWrite>
  8. <DiskId>d-23b3p4r8b</DiskId>
  9. <IOPSRead>0</IOPSRead>
  10. <IOPSTotal>0</IOPSTotal>
  11. <IOPSWrite>0</IOPSWrite>
  12. <TimeStamp>2014-07-23T12:07:00Z</TimeStamp>
  13. </DiskMonitorData>
  14. <DiskMonitorData>
  15. <BPSRead>0</BPSRead>
  16. <BPSTotal>204</BPSTotal>
  17. <BPSWrite>204</BPSWrite>
  18. <DiskId>d-23b3p4r8b</DiskId>
  19. <IOPSRead>0</IOPSRead>
  20. <IOPSTotal>0</IOPSTotal>
  21. <IOPSWrite>0</IOPSWrite>
  22. <TimeStamp>2014-07-23T12:08:00Z</TimeStamp>
  23. </DiskMonitorData>
  24. <DiskMonitorData>
  25. <BPSRead>0</BPSRead>
  26. <BPSTotal>819</BPSTotal>
  27. <BPSWrite>819</BPSWrite>
  28. <DiskId>d-23b3p4r8b</DiskId>
  29. <IOPSRead>0</IOPSRead>
  30. <IOPSTotal>0</IOPSTotal>
  31. <IOPSWrite>0</IOPSWrite>
  32. <TimeStamp>2014-07-23T12:09:00Z</TimeStamp>
  33. </DiskMonitorData>
  34. </MonitorData>
  35. <RequestId>BF666447-B171-4076-BCBA-48437C18FD76</RequestId>
  36. <TotalCount>3</TotalCount>
  37. </DescribeDiskMonitorDataResponse>

JSON format

  1. {
  2. "MonitorData": {
  3. "DiskMonitorData": [
  4. {
  5. "BPSRead": 0,
  6. "BPSTotal": 0,
  7. "BPSWrite": 0,
  8. "DiskId": "d-23b3p4r8b",
  9. "IOPSRead": 0,
  10. "IOPSTotal": 0,
  11. "IOPSWrite": 0,
  12. "TimeStamp": "2014-07-23T12:07:00Z"
  13. },
  14. {
  15. "BPSRead": 0,
  16. "BPSTotal": 204,
  17. "BPSWrite": 204,
  18. "DiskId": "d-23b3p4r8b",
  19. "IOPSRead": 0,
  20. "IOPSTotal": 0,
  21. "IOPSWrite": 0,
  22. "TimeStamp": "2014-07-23T12:08:00Z"
  23. },
  24. {
  25. "BPSRead": 0,
  26. "BPSTotal": 819,
  27. "BPSWrite": 819,
  28. "DiskId": "d-23b3p4r8b",
  29. "IOPSRead": 0,
  30. "IOPSTotal": 0,
  31. "IOPSWrite": 0,
  32. "TimeStamp": "2014-07-23T12:09:00Z"
  33. }
  34. ]
  35. },
  36. "RequestId": "A48A0A77-34F5-4C33-9066-9E8D2DA0D8E2",
  37. "TotalCount": 3
  38. }
Thank you! We've received your feedback.