操作指南

API 文档

云产品监控指标

文档中心 > 云监控 > 最佳实践 > 使用 API 拉取云产品监控数据

使用 API 拉取云产品监控数据

最近更新时间:2022-04-28 21:23:36

本文为您介绍如何使用 API 拉取腾讯云各产品监控数据。

接口介绍

云监控提供以下3类接口用于指标类监控数据的查询

API 操作名 操作描述
DescribeProductList 查询产品列表接口 查询云监控支持哪些产品的监控项
DescribeBaseMetrics 查询监控基础指标详情接口 查询对应的名字空间下面的监控指标类型
GetMonitorData 拉取指标监控数据 对象维度描述和监控指标获取相应的监控数据

接口相关限制

  • GetMonitorData 接口支持批量获取用户下所有实例的某个指标的数据。
  • GetMonitorData 接口默认支持请求频率限制:20次/秒,1200次/分钟。单请求最多可支持批量拉取10个实例的监控数据,单请求的数据点数限制为1440个。
  • 监控数据存储时长,不同的监控粒度存储时长不同。详情请参考下列图表:
    监控粒度 存储时长
    秒级 1天
    1分钟 15天
    5分钟 31天
    1小时 93天
    1天 186天
    说明:

    云服务器包含 CPU、内存、网络相关指标1分钟监控粒度的存储时长为31天。

准备工作

准备个人密钥

  1. 登录 API 密钥管理
  2. 若还未创建密钥,则需单击新建密钥以创建密钥;若已创建密钥,可单击 SecretKey 的显示获取密钥。

准备云产品指标信息

本文以云服务器 CPU 利用率指标为例。

  1. 查看 云服务器监控指标文档,
  2. 找到 CPU 利用率指标,即可查看 CPU 利用率指标名、维度,统计粒度等相关信息。

实践步骤

通过 Demo 演示,为您介绍如何使用 GetMonitorData 接口查询 CVM 的 CPU 利用率。

  1. 登录 API Explorer 在线调试页面。
  2. 准备好的个人密钥 对应复制到对应的 SecretId、SecretKey 文本框。
  3. 输入参数配置项找到 Region,选择相关地域。
  4. 准备好的云产品信息,填入对应的输入参数配置项文本框。
    • Namespace:填入 QCE/CVM。
    • MetricName:填入 CPU 利用率指标英文名,即 CPUUsage。
    • Dimensions.N-Name:填入支持的维度名称,即 InstanceId。
    • Dimensions.N-Value:填入对应的 InstanceId 值(云服务器实例 ID),可通过云服务器 查询实例列表接口 获取实例对应的 ID,例如 ins—12345678。
    • Period:填入指标支持的统计粒度,例如300。
    • StartTime:填入需要查询的起始时间(时间类型为 datetime_iso),格式为 2020-12-20T19:51:23+08:00
    • EndTime:填入需要查询的起始时间结束时间(时间类型为 datetime_iso),EndTime 不能小于 StartTime。格式为 2020-12-20T20:51:23+08:00
  5. 以上信息填完后,您可以复制代码生成中对应语言的代码,将相关的监控数据集成到您的自建监控系统,您还可以使用在线调用发送请求进行在线查询监控数据。
目录