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
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DiskId | string | Yes | The disk ID. | d-bp1bq5g3dxxo1x4o**** |
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 rounded up to the next minute. | 2014-07-23T12:07: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 rounded up to the next minute. | 2014-07-23T12:09:00Z |
Period | integer | No | The interval at which you want to query the monitoring data. Unit: seconds. Valid values:
Default value: 60. | 60 |
Response parameters
Examples
Sample success responses
JSON
format
{
"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 code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidStartTime.Malformed | The specified parameter "StartTime" is not valid. | - |
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. | - |
400 | Throttling | Request was denied due to request throttling. | - |
400 | InvalidInstanceType.NotSupportCredit | The InstanceType of the specified instance does not support credit. | The instance type does not support burstable instances. |
400 | InvalidParameter.EndTime | The specified parameter EndTime is earlier than StartTime. | The end time cannot be earlier than the start time. |
404 | InvalidDiskId.NotFound | The DiskId provided does not exist in our records. | The specified disk does not exist. Check whether the disk ID is correct. |
500 | InternalError | The 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 time | Summary of changes | Operation | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2023-05-06 | The Error code has changed | see changesets | ||||||||
|