All Products
Search
Document Center

Elastic Compute Service:DescribeDiskMonitorData

Last Updated:Feb 04, 2024

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

Operation description

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

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

  • Only the monitoring data of disks that are in the Running (In_use) state can be queried. For more information, see Disk states.

    **

    NoteSome 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.

  • A maximum of 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 a maximum of the last 30 days. If the value of StartTime is greater 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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
DiskIdstringYes

The disk ID.

d-bp1bq5g3dxxo1x4o****
StartTimestringYes

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 rounded up to the next minute.

2014-07-23T12:07:00Z
EndTimestringYes

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 rounded up to the next minute.

2014-07-23T12:09:00Z
PeriodintegerNo

The interval at which you want to query the monitoring data. Unit: seconds. Valid values:

  • 60
  • 600
  • 3600

Default value: 60.

60

Response parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

The total number of returned monitoring data entries.

3
RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
MonitorDataobject []

The details about the monitoring data of the disk.

BPSReadinteger

The read bandwidth of the system disk. Unit: byte/s.

0
IOPSReadinteger

The number of read I/O operations per second on the system disk.

0
LatencyReadinteger

The read latency of the disk. Unit: microseconds.

0
BPSTotalinteger

The total read and write bandwidth of the system disk. Unit: byte/s.

204
IOPSTotalinteger

The total number of read and write I/O operations per second on the system disk.

0
TimeStampstring

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.

2014-07-23T12:07:00Z
LatencyWriteinteger

The write latency of the disk. Unit: microseconds.

0
IOPSWriteinteger

The number of write I/O operations per second on the system disk.

0
DiskIdstring

The disk ID.

d-bp1bq5g3dxxo1x4o****
BPSWriteinteger

The write bandwidth of the system disk. Unit: byte/s.

204

Examples

Sample success responses

JSONformat

{
  "TotalCount": 3,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "MonitorData": {
    "DiskMonitorData": [
      {
        "BPSRead": 0,
        "IOPSRead": 0,
        "LatencyRead": 0,
        "BPSTotal": 204,
        "IOPSTotal": 0,
        "TimeStamp": "2014-07-23T12:07:00Z",
        "LatencyWrite": 0,
        "IOPSWrite": 0,
        "DiskId": "d-bp1bq5g3dxxo1x4o****",
        "BPSWrite": 204
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidStartTime.MalformedThe specified parameter "StartTime" is not valid.-
400InvalidEndTime.MalformedThe specified parameter "EndTime" is not valid.The specified EndTime parameter is invalid.
400InvalidPeriod.ValueNotSupportedThe specified parameter "Period" is not valid.-
400InvalidStartTime.TooEarlyThe specified parameter "StartTime" is too early.-
400InvalidParameter.TooManyDataQueriedToo many data queried.-
400ThrottlingRequest was denied due to request throttling.-
400InvalidInstanceType.NotSupportCreditThe InstanceType of the specified instance does not support credit.The instance type does not support burstable instances.
400InvalidParameter.EndTimeThe specified parameter EndTime is earlier than StartTime.The end time cannot be earlier than the start time.
404InvalidDiskId.NotFoundThe DiskId provided does not exist in our records.The specified disk does not exist. Check whether the disk ID is correct.
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.An internal error has occurred. Try again later.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-05-06The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 404
    delete Error Codes: 500