DescribeDiskMonitorData - 查询一块云盘指定时间内的使用信息

调用DescribeDiskMonitorData接口，并可以指定DiskId、StartTime、EndTime等参数，查询一块云盘在指定时间内的使用信息。

接口说明

可查询云盘使用信息包括读 IOPS、写 IOPS、读带宽（B/s）、写带宽（B/s）、读时延（μs）以及写时延（μs）。

调用该接口时，您需要注意：

只能查询状态为使用中（In_use）的云盘使用信息。更多详情，请参见普通云盘状态表。

说明若查询的信息中出现内容缺失，是因为无法获取该段时间的使用信息，即云盘状态不是使用中（In_use）。
一次最多返回 400 条数据，需满足（EndTime–StartTime）/Period小于等于 400 的条件限制，即返回参数TotalCount不能超过 400，否则将返回InvalidParameter.TooManyDataQueried的错误提示。
一次最多能查询近 30 天内的监控信息，即指定的参数StartTime距今不能超过 30 天。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
DiskId	string	是	云盘 ID。	d-bp1bq5g3dxxo1x4o****
StartTime	string	是	数据的起始时间。按照ISO 8601标准表示，并使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。如果秒（ss）不是 00，则自动取为下一分钟开始时。	2014-07-23T12:07:00Z
EndTime	string	是	数据的结束时间。按照ISO 8601标准表示，并使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。如果秒（ss）不是 00，则自动取为下一分钟开始时。	2014-07-23T12:09:00Z
Period	integer	否	数据的精度，单位为秒。取值范围： 60。 600。 3600。默认值：60。	60

返回参数

名称	类型	描述	示例值
	object
TotalCount	integer	云盘使用信息的返回条目数量。	3
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
MonitorData	array<object>	云盘的监控数据集合。
DiskMonitorData	object	云盘的监控数据集合。
BPSRead	integer	云盘读带宽，单位：Byte/s。	0
IOPSRead	integer	云盘 I/O 读操作，单位：次/s。	0
LatencyRead	integer	云盘读时延。单位：μs（微秒）。	0
BPSTotal	integer	云盘读写总带宽，单位：Byte/s。	204
IOPSTotal	integer	云盘 I/O 读写总操作，单位：次/s。	0
TimeStamp	string	查询监控信息的时间戳。按照ISO 8601标准表示，并使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2014-07-23T12:07:00Z
LatencyWrite	integer	云盘写时延。单位：μs（微秒）。	0
IOPSWrite	integer	云盘 I/O 写操作，单位：次/s。	0
DiskId	string	云盘 ID。	d-bp1bq5g3dxxo1x4o****
BPSWrite	integer	云盘写带宽，单位：Byte/s。	204

示例

正常返回示例

JSON格式

{
  "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
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidStartTime.Malformed	The specified parameter "StartTime" is not valid.	-
400	InvalidEndTime.Malformed	The specified parameter "EndTime" is not valid.	传入的参数EndTime不符合规则。
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.	实例规格不支持突发性能实例。
400	InvalidParameter.EndTime	The specified parameter EndTime is earlier than StartTime.	结束时间不能早于开始时间。
404	InvalidDiskId.NotFound	The DiskId provided does not exist in our records.	指定的磁盘不存在。请您检查磁盘 ID 是否正确。
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	内部错误，请重试。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2023-05-06	OpenAPI 错误码发生变更	查看变更详情