块存储监控接口

最近更新时间:2019-06-27 20:07:28

1. 接口描述

接口:GetMonitorData
接口请求域名: monitor.tencentcloudapi.com

获取云产品的监控数据。传入产品的命名空间、对象维度描述和监控指标即可获得相应的监控数据。

接口调用频率限制为:20次/秒,1200次/分钟。 单请求最多可支持批量拉取10个实例的监控数据,单请求的数据点数限制为1440个。

若您需要调用的指标、对象较多,可能存在因限频出现拉取失败的情况,建议尽量将请求按时间维度均摊。

查询块存储监控数据,入参取值如下:
&Namespace=QCE/BLOCK_STORAGE
&Instances.N.Dimensions.0.Name=diskId
&Instances.N.Dimensions.0.Value=块存储 ID

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共请求参数,正式调用时需要加上全部公共请求参数,详情请参见 公共请求参数 文档。

2.1 输入参数

2.1.1 输入参数总览

参数名称 是否必选 类型 描述
Action String 公共参数,本接口取值:GetMonitorData
Version String 公共参数,本接口取值: 2018-07-24
Region String 公共参数,表示查询的是哪个地域实例的监控数据;支持的地域可查看云服务器支持的 地域列表
Namespace String 命名空间,每个云产品会有一个命名空间,API 3.0接口版本的必须是大写,如:QCE/BLOCK_STORAGE
MetricName String 指标名称,具体名称见2.2
Instances.N Array of Instance 实例对象的维度组合
Period Integer 监控统计周期。默认为取值为300,单位为s
StartTime Timestamp 起始时间,如"2016-01-01 10:25:00"。 默认时间为当天的”00:00:00”
EndTime Timestamp 结束时间,默认为当前时间。 endTime 不能小于 startTime

2.1.2 各维度对应参数总览

参数名称 维度名称 维度解释 格式
Instances.N.Dimensions.0.Name diskId 块存储实例的 ID String 类型维度名称:diskId
Instances.N.Dimensions.0.Value diskId 块存储实例的 ID 具体实例名称,如 disk-test

2.2 指标名称

每个指标对应的统计粒度(Period)及维度(dimension)可取值不一定相同,可通过 DescribeBaseMetrics 接口获取每个指标支持的统计粒度及维度信息。

指标名称 指标中文名称 计算方式 指标含义 单位 统计粒度(period)
DiskReadIops 硬盘读 IOPS 块存储在统计周期内读 IOPS 的平均值 每秒从块存储读到内存中的 IO 次数 次数 10s、60s、300s
DiskReadTraffic 硬盘读流量 块存储在统计周期内读吞吐量的平均值 数据从块存储读取到内存中的速率 MB/s 10s、60s、300s
DiskWriteIops 硬盘写 IOPS 块存储在统计周期内写 IOPS 的平均值 每秒从内存写到块存储中的 IO 次数 次数 10s、60s、300s
DiskWriteTraffic 硬盘写流量 块存储在统计周期内写吞吐量的平均值 数据从内存写入到块存储中的速率 MB/s 10s、60s、300s
DiskAwait 硬盘 IO 等待时间 块存储在统计周期内 ioawait 的平均值 在采样周期内有百分之几的时间 CPU 空闲并且有仍未完成的 I/O 请求 ms 10s、60s、300s
DiskSvctm 硬盘 IO 服务时间 块存储在统计周期内 svctm 的平均值 IO 服务时间 ms 10s、60s、300s
DiskUtil 硬盘 IO 繁忙比率 块存储在统计周期内 io_util 的平均值 硬盘有 IO 操作的时间(即非空间时间)的比率 % 10s、60s、300s

3. 输出参数

参数名称 类型 描述
MetricName String 监控指标
StartTime Timestamp 数据点起始时间
EndTime Timestamp 数据点结束时间
Period Integer 数据统计周期
DataPoints Array of PointsObject 监控数据列表
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId

4. 示例

示例1

拉取某个硬盘某段时间内统计周期为60秒的IO繁忙比率监控数据。

输入示例

https://monitor.tencentcloudapi.com/?Action=GetMonitorData
&Namespace=QCE/BLOCK_STORAGE
&MetricName=DiskUtil
&Period=60
&StartTime=2019-05-08T16:40:00+08:00
&EndTime=2018-05-08T16:45:00+08:00
&Instances.0.Dimensions.0.Name=diskId
&Instances.0.Dimensions.0.Value=disk-test
&<公共请求参数>

输出示例

{
  "Response": {
    "StartTime": "2019-05-08 16:40:00",
    "EndTime": "2019-05-08 16:45:00",
    "Period": 60,
    "MetricName": "DiskUtil",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "diskId",
            "Value": "disk-test"
          }
        ],
        "Timestamps": [
          1557304800,
          1557304860,
          1557304920,
          1557304980,
          1557305040,
          1557305100
        ],
        "Values": [
          0.105,
          0.1,
          0.071,
          0.295,
          0.096,
          0.098
        ]
      }
    ],
    "RequestId": "0ea9aeee-3bf8-46a0-b594-c2b9e1b7f0bf"
  }
}

示例2

拉取多个硬盘某段时间内统计周期为60秒的IO繁忙比率监控数据。

输入示例

https://monitor.tencentcloudapi.com/?Action=GetMonitorData
&Namespace=QCE/BLOCK_STORAGE
&MetricName=DiskUtil
&Period=60
&StartTime=2019-05-08T16:40:00+08:00
&EndTime=2018-05-08T16:45:00+08:00
&Instances.0.Dimensions.0.Name=diskId
&Instances.0.Dimensions.0.Value=disk-test1
&Instances.1.Dimensions.0.Name=diskId
&Instances.1.Dimensions.0.Value=disk-test2
&<公共请求参数>

输出示例

{
  "Response": {
    "StartTime": "2019-05-08 16:40:00",
    "EndTime": "2019-05-08 16:45:00",
    "Period": 60,
    "MetricName": "DiskUtil",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "diskId",
            "Value": "disk-test1"
          }
        ],
        "Timestamps": [
          1557304800,
          1557304860,
          1557304920,
          1557304980,
          1557305040,
          1557305100
        ],
        "Values": [
          0.105,
          0.1,
          0.071,
          0.295,
          0.096,
          0.098
        ]
      },
      {
        "Dimensions": [
          {
            "Name": "diskId",
            "Value": "disk-test2"
          }
        ],
        "Timestamps": [
          1557304800,
          1557304860,
          1557304920,
          1557304980,
          1557305040,
          1557305100
        ],
        "Values": [
          0.105,
          0.1,
          0.071,
          0.295,
          0.096,
          0.098
        ]
      }
    ],
    "RequestId": "0ea9aeee-3bf8-46a0-b594-c2b9e1b7f0bf"
  }
}