文档

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

更新时间:

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

接口说明

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

调用该接口时,您需要注意:

  • 只能查询状态为使用中(In_Use)的云盘使用信息。更多详情,请参见普通云盘状态表

    说明 若查询的信息中出现内容缺失,是因为无法获取该段时间的使用信息,即云盘状态不是使用中(In_Use)。
  • 一次最多返回 400 条数据,即指定的(EndTime–StartTime)/Period不能超过 400。

  • 一次最多能查询近 30 天内的监控信息,即指定的参数StartTime不能超过 30 天。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:DescribeDiskMonitorDataREAD
  • Disk
    acs:ecs:{#regionId}:{#accountId}:disk/{#diskId}
  • ecs:tag

请求参数

名称类型必填描述示例值
DiskIdstring

云盘 ID。

d-bp1bq5g3dxxo1x4o****
StartTimestring

数据的起始时间。按照 ISO8601 标准表示,并使用 UTC +0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。如果秒(ss)不是 00,则自动取为下一分钟开始时。

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

数据的结束时间。按照 ISO8601 标准表示,并使用 UTC +0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。如果秒(ss)不是 00,则自动取为下一分钟开始时。

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

数据的精度,单位为秒。取值范围:

  • 60
  • 600
  • 3600

默认值:60

60

返回参数

名称类型描述示例值
object
TotalCountinteger

云盘使用信息的返回条目数量。

3
RequestIdstring

请求 ID。

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

云盘的监控数据集合。

BPSReadinteger

系统盘读带宽,单位:Byte/s。

0
IOPSReadinteger

系统盘 I/O 读操作,单位:次/s。

0
LatencyReadinteger

云盘读时延。单位:μs(微秒)。

0
BPSTotalinteger

系统盘读写总带宽,单位:Byte/s。

204
IOPSTotalinteger

系统盘 I/O 读写总操作,单位:次/s。

0
TimeStampstring

查询监控信息的时间戳。按照 ISO8601 标准表示,并使用 UTC +0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

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

云盘写时延。单位:μs(微秒)。

0
IOPSWriteinteger

系统盘 I/O 写操作,单位:次/s。

0
DiskIdstring

云盘 ID。

d-bp1bq5g3dxxo1x4o****
BPSWriteinteger

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

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

变更历史

变更时间变更内容概要操作
2023-05-06OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
    删除错误码:500
  • 本页导读 (1)
文档反馈