调用DescribeDiskMonitorData查询一块云盘指定时间内的使用信息。
接口说明
可查询云盘实用信息包括读IOPS、写IOPS、读带宽(B/s)、写带宽(B/s)、读时延(μs)以及写时延(μs)。
调用该接口时,您需要注意:
- 一次最多返回400条数据,即指定的
(EndTime–StartTime)/Period
不能超过400。 - 一次最多能查询近30天内的监控信息,即指定的参数
StartTime
不能超过30天。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeDiskMonitorData | 系统规定参数。取值:DescribeDiskMonitorData |
DiskId | String | 是 | d-bp1bq5g3dxxo1x4o**** | 云盘ID。 |
EndTime | String | 是 | 2014-07-23T12:09:00Z | 数据的结束时间。按照ISO8601标准表示,并使用UTC +0时间,格式为yyyy-MM-ddTHH:mm:ssZ。如果秒(ss)不是00,则自动取为下一分钟开始时。 |
StartTime | String | 是 | 2014-07-23T12:07:00Z | 数据的起始时间。按照ISO8601标准表示,并使用UTC +0时间,格式为yyyy-MM-ddTHH:mm:ssZ。如果秒(ss)不是00,则自动取为下一分钟开始时。 |
Period | Integer | 否 | 60 | 数据的精度,单位为秒。取值范围:
默认值:60 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
MonitorData | Array of DiskMonitorData | 云盘的监控数据集合。 |
|
DiskMonitorData | |||
BPSRead | Integer | 0 | 系统盘读带宽,单位:Byte/s。 |
BPSTotal | Integer | 204 | 系统盘读写总带宽,单位:Byte/s。 |
BPSWrite | Integer | 204 | 系统盘写带宽,单位:Byte/s。 |
DiskId | String | d-bp1bq5g3dxxo1x4o**** | 云盘ID。 |
IOPSRead | Integer | 0 | 系统盘I/O读操作,单位:次/s。 |
IOPSTotal | Integer | 0 | 系统盘I/O读写总操作,单位:次/s。 |
IOPSWrite | Integer | 0 | 系统盘I/O写操作,单位:次/s。 |
LatencyRead | Integer | 0 | 云盘读时延。单位:μs(微秒)。 |
LatencyWrite | Integer | 0 | 云盘写时延。单位:μs(微秒)。 |
TimeStamp | String | 2014-07-23T12:07:00Z | 查询监控信息的时间戳。按照ISO8601标准表示,并使用UTC +0时间,格式为yyyy-MM-ddTHH:mm:ssZ。 |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E | 请求ID。 |
TotalCount | Integer | 3 | 云盘使用信息的返回条目数量。 |
示例
请求示例
1 2 3 4 5 6 | https: //ecs.aliyuncs.com/?Action=DescribeDiskMonitorData &DiskId=d-bp1bq5g3dxxo1x4o**** &EndTime= 2014 - 07 -23T12: 09 :00Z &StartTime= 2014 - 07 -23T12: 07 :00Z &Period= 60 &<公共请求参数> |
正常返回示例
XML
格式
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 | <DescribeDiskMonitorDataResponse> <MonitorData> <DiskMonitorData> <BPSRead> 0 </BPSRead> <BPSTotal> 0 </BPSTotal> <BPSWrite> 0 </BPSWrite> <DiskId>d-bp1bq5g3dxxo1x4o****</DiskId> <IOPSRead> 0 </IOPSRead> <IOPSTotal> 0 </IOPSTotal> <IOPSWrite> 0 </IOPSWrite> <TimeStamp> 2014 - 07 -23T12: 07 :00Z</TimeStamp> </DiskMonitorData> <DiskMonitorData> <BPSRead> 0 </BPSRead> <BPSTotal> 204 </BPSTotal> <BPSWrite> 204 </BPSWrite> <DiskId>d-bp1bq5g3dxxo1x4o****</DiskId> <IOPSRead> 0 </IOPSRead> <IOPSTotal> 0 </IOPSTotal> <IOPSWrite> 0 </IOPSWrite> <TimeStamp> 2014 - 07 -23T12: 08 :00Z</TimeStamp> </DiskMonitorData> <DiskMonitorData> <BPSRead> 0 </BPSRead> <BPSTotal> 819 </BPSTotal> <BPSWrite> 819 </BPSWrite> <DiskId>d-bp1bq5g3dxxo1x4o****</DiskId> <IOPSRead> 0 </IOPSRead> <IOPSTotal> 0 </IOPSTotal> <IOPSWrite> 0 </IOPSWrite> <TimeStamp> 2014 - 07 -23T12: 09 :00Z</TimeStamp> </DiskMonitorData> </MonitorData> <RequestId>BF666447-B171- 4076 -BCBA-48437C18FD76</RequestId> <TotalCount> 3 </TotalCount> </DescribeDiskMonitorDataResponse> |
JSON
格式
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 | { "MonitorData" : { "DiskMonitorData" : [ { "BPSRead" : 0 , "BPSTotal" : 0 , "BPSWrite" : 0 , "DiskId" : "d-bp1bq5g3dxxo1x4o****" , "IOPSRead" : 0 , "IOPSTotal" : 0 , "IOPSWrite" : 0 , "TimeStamp" : "2014-07-23T12:07:00Z" }, { "BPSRead" : 0 , "BPSTotal" : 204 , "BPSWrite" : 204 , "DiskId" : "d-bp1bq5g3dxxo1x4o****" , "IOPSRead" : 0 , "IOPSTotal" : 0 , "IOPSWrite" : 0 , "TimeStamp" : "2014-07-23T12:08:00Z" }, { "BPSRead" : 0 , "BPSTotal" : 819 , "BPSWrite" : 819 , "DiskId" : "d-bp1bq5g3dxxo1x4o****" , "IOPSRead" : 0 , "IOPSTotal" : 0 , "IOPSWrite" : 0 , "TimeStamp" : "2014-07-23T12:09:00Z" } ] }, "RequestId" : "A48A0A77-34F5-4C33-9066-9E8D2DA0D8E2" , "TotalCount" : 3 } |
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
404 | InvalidDiskId.NotFound | The DiskId provided does not exist in our records. | 指定的磁盘不存在。请您检查磁盘ID是否正确。 |
400 | InvalidStartTime.Malformed | The specified parameter "StartTime" is not valid. | 指定的开始时间格式不合法。 |
400 | InvalidEndTime.Malformed | The specified parameter "EndTime" is not valid. | 指定的结束时间格式不合法。 |
400 | InvalidPeriod.ValueNotSupported | The specified parameter "Period" is not valid. | 指定的Period参数不合法。 |
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. | 结束时间不能早于开始时间。 |
500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 内部错误,请重试。如果多次尝试失败,请提交工单。 |
访问错误中心查看更多错误码。