文档

DescribeDiskMonitorData - 查询云盘监控

更新时间:

查询单个云盘的秒级监控数据。

接口说明

  • 查询结果一次最多返回 400 条数据,即指定的(EndTime-StartTime)/Period不能超过 400。

  • 查询结果一次最多能查询近 3 天内的监控信息,即StartTime指定的时间与当前时间相差不能超过 3 天。

调试

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

授权信息

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

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

请求参数

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

地域 ID。

cn-hangzhou
DiskIdstring

云盘 ID。

d-bp67acfmxazb4p****
StartTimestring

获取云盘的秒级监控数据的起始时间点。按照ISO 8601标准表示,并使用 UTC +0 时间,格式为yyyy-MM-ddTHH:mm:ssZ

2022-06-01T03:00:00Z
EndTimestring

获取云盘的秒级监控数据的结束时间点。按照ISO 8601标准表示,并使用 UTC+0 时间,格式为yyyy-MM-ddTHH:mm:ssZ

2022-06-01T05:00:00Z
Periodlong

获取云盘的秒级监控数据的间隔时间。单位:秒。取值范围:

  • 5。
  • 60。

默认值:5。

5
Typestring

磁盘监控数据类型。取值范围:

  • basic:基础性能数据。

  • pro:包含 Burst IO 数据。

basic

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
TotalCountlong

查询结果总条数。

15
MonitorDataobject []

云盘的秒级监控数据集合。

ReadBPSlong

云盘读带宽,单位:MBps。

10
WriteBPSlong

云盘写带宽,单位:MBps。

204
DiskIdstring

云盘 ID。

d-bp1bq5g3dxxo1x4o****
ReadIOPSlong

每秒读操作的次数上限,单位:次/s。

2000
WriteIOPSlong

每秒写操作的次数上限,单位:次/s。

2000
IOPSPercentlong

云盘 IOPS 水位占比。

80(%)
BPSPercentlong

云盘 BPS 水位占比。

80(%)
Timestampstring

查询云盘的秒级监控数据的时间戳。按照ISO 8601标准表示,并使用 UTC +0 时间,格式为yyyy-MM-ddTHH:mm:ssZ

2022-06-01T08:00:00Z
BurstIOCountlong

云盘 Burst IO 数量。

0
ReadBlockSizelong

读 IO 块大小,单位:Bytes

4096
WriteBlockSizelong

写 IO 块大小,单位:Bytes

4096
ReadLatencylong

读延迟,单位:微秒

100
WriteLatencylong

写延迟,单位:微秒

100

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "TotalCount": 15,
  "MonitorData": [
    {
      "ReadBPS": 10,
      "WriteBPS": 204,
      "DiskId": "d-bp1bq5g3dxxo1x4o****",
      "ReadIOPS": 2000,
      "WriteIOPS": 2000,
      "IOPSPercent": 0,
      "BPSPercent": 0,
      "Timestamp": "2022-06-01T08:00:00Z",
      "BurstIOCount": 0,
      "ReadBlockSize": 4096,
      "WriteBlockSize": 4096,
      "ReadLatency": 100,
      "WriteLatency": 100
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
403ForbiddenUser is not authorized to operate.当前用户无权限对当前资源执行任何操作。请检查您的账号权限或者咨询您的主账号管理员。
403Forbidden.ActionUser is not authorized to operate this action.当前用户无权限执行该操作。请检查您的账号权限或者咨询您的主账号管理员。
404NoSuchResourceThe specified resource does not exist.指定的资源不存在。
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.内部错误。
504RequestTimeoutThe request is timeout, please try again later.该请求超时,请稍后再重试。

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

变更历史

变更时间变更内容概要操作
2024-02-02OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈