Queries the monitoring data of a disk in a specific period of time. When you call this operation, you can specify parameters, such as DiskId, StartTime, and EndTime, in the request.
Operation description
Usage notes
You can query the following monitoring data of a disk: the read IOPS, write IOPS, read bandwidth (byte/s), write bandwidth (byte/s), read latency (microseconds), and write latency (microseconds).
Take note of the following items:
-
Monitoring data of only disks that are in the In Use (
In_use
) state can be queried. 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. Make sure that the
TotalCount
value does not exceed 400. The value is calculated by using the following formula:TotalCount = (EndTime - StartTime)/Period
. If the TotalCount value is greater than 400, theInvalidParameter.TooManyDataQueried
error is returned. -
You can query the monitoring data in the last 30 days. If the value of
StartTime
is more than 30 days earlier than the current time, an error is returned.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
ecs:DescribeDiskMonitorData | get |
|
| none |
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 to retrieve 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 | View Change Details |