操作指南

API 文档

云产品监控指标

拉取指标监控数据

最近更新时间:2021-06-28 08:07:02

我的收藏

1. 接口描述

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

获取云产品的监控数据。此接口不适用于拉取容器服务监控数据,如需拉取容器服务监控数据,请使用根据维度条件查询监控数据接口。 传入产品的命名空间、对象维度描述和监控指标即可获得相应的监控数据。 接口调用频率限制为:20次/秒,1200次/分钟。单请求最多可支持批量拉取10个实例的监控数据,单请求的数据点数限制为1440个。 若您需要调用的指标、对象较多,可能存在因限频出现拉取失败的情况,建议尽量将请求按时间维度均摊。

默认接口请求频率限制:20次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:monitor.ap-shanghai-fsi.tencentcloudapi.com。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetMonitorData。
Version String 公共参数,本接口取值:2018-07-24。
Region String 公共参数,详见产品支持的 地域列表
Namespace String 命名空间,如QCE/CVM。各个云产品的详细命名空间说明请参阅各个产品监控指标文档
MetricName String 指标名称,如CPUUsage,仅支持单指标拉取。各个云产品的详细指标说明请参阅各个产品监控指标文档,对应的指标英文名即为MetricName
Instances.N Array of Instance 实例对象的维度组合,格式为key-value键值对形式的集合。不同类型的实例字段完全不同,如CVM为[{"Name":"InstanceId","Value":"ins-j0hk02zo"}],Ckafka为[{"Name":"instanceId","Value":"ckafka-l49k54dd"}],COS为[{"Name":"appid","Value":"1258344699"},{"Name":"bucket","Value":"rig-1258344699"}]。各个云产品的维度请参阅各个产品监控指标文档,对应的维度列即为维度组合的key,value为key对应的值。单请求最多支持批量拉取10个实例的监控数据。
Period Integer 监控统计周期,如60。默认为取值为300,单位为s。每个指标支持的统计周期不一定相同,各个云产品支持的统计周期请参阅各个产品监控指标文档,对应的统计周期列即为支持的统计周期。单请求的数据点数限制为1440个。
StartTime Timestamp ISO8601 起始时间,如2018-09-22T19:51:23+08:00
EndTime Timestamp ISO8601 结束时间,如2018-09-22T20:51:23+08:00,默认为当前时间。 EndTime不能小于StartTime

3. 输出参数

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

4. 示例

示例1 拉取单台云服务器监控数据

拉取某台云服务器某段时间内统计周期为5分钟的CPU利用率监控数据

输入示例

POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetMonitorData
<公共请求参数>

{
    "Namespace": "QCE/CVM",
    "MetricName": "CPUUsage",
    "Period": 300,
    "Instances": [
        {
            "Dimensions": [
                {
                    "Name": "InstanceId",
                    "Value": "ins-j0hk02zo"
                }
            ]
        }
    ],
    "StartTime": "2019-03-24T10:51:23+08:00",
    "EndTime": "2019-03-24T20:51:23+08:00"
}

输出示例

{
  "Response": {
    "StartTime": "2019-03-24T10:50:00+08:00",
    "EndTime": "2019-03-24T20:50:00+08:00",
    "Period": 300,
    "MetricName": "CPUUsage",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "InstanceId",
            "Value": "ins-j0hk02zo"
          }
        ],
        "Timestamps": [
          1535079000,
          1535079300,
          1535079600,
          1535079900,
          1535080200,
          1535080500
        ],
        "Values": [
          2.566,
          2.283,
          6.316,
          2.816,
          2.7,
          2.35
        ]
      }
    ],
    "RequestId": "d96ec542-6547-4af2-91ac-fee85c1b8b85"
  }
}

示例2 拉取多台云服务器监控数据

拉取多台云服务器某段时间内统计周期为5分钟的CPU利用率监控数据

输入示例

POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetMonitorData
<公共请求参数>

{
    "Namespace": "QCE/CVM",
    "MetricName": "CPUUsage",
    "Period": 300,
    "Instances": [
        {
            "Dimensions": [
                {
                    "Name": "InstanceId",
                    "Value": "ins-j0hk02zo"
                }
            ]
        },
        {
            "Dimensions": [
                {
                    "Name": "InstanceId",
                    "Value": "ins-o8vv2w10"
                }
            ]
        }
    ],
    "StartTime": "2018-09-22T19:51:23+08:00",
    "EndTime": "2018-09-22T20:51:23+08:00"
}

输出示例

{
  "Response": {
    "StartTime": "2018-09-22T19:50:00+08:00",
    "EndTime": "2018-09-22T20:50:00+08:00",
    "Period": 300,
    "MetricName": "CPUUsage",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "InstanceId",
            "Value": "ins-j0hk02zo"
          }
        ],
        "Timestamps": [],
        "Values": []
      },
      {
        "Dimensions": [
          {
            "Name": "InstanceId",
            "Value": "ins-o8vv2w10"
          }
        ],
        "Timestamps": [],
        "Values": []
      }
    ],
    "RequestId": "9ac53ccc-fbab-483d-980b-b763bcc2f83f"
  }
}

示例3 拉取单台CDB监控数据

拉取某台CDB实例某段时间内统计周期为5分钟的CPU利用率监控数据

输入示例

POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetMonitorData
<公共请求参数>

{
    "Namespace": "QCE/CDB",
    "MetricName": "SlowQueries",
    "Period": 300,
    "Instances": [
        {
            "Dimensions": [
                {
                    "Name": "InstanceId",
                    "Value": "cdb-k5d6z7p0"
                },
                {
                    "Name": "InstanceType",
                    "Value": "2"
                }
            ]
        }
    ],
    "StartTime": "2018-09-22T19:23:07+08:00",
    "EndTime": "2018-09-22T20:23:07+08:00"
}

输出示例

{
  "Response": {
    "StartTime": "2018-09-22T19:20:00+08:00",
    "EndTime": "2018-09-22T20:20:00+08:00",
    "Period": 300,
    "MetricName": "SlowQueries",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "InstanceType",
            "Value": "2"
          },
          {
            "Name": "InstanceId",
            "Value": "cdb-k5d6z7p0"
          }
        ],
        "Timestamps": [],
        "Values": []
      }
    ],
    "RequestId": "2bcfe8b7-8ea8-4488-9d17-f1aeb106eecd"
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameterValue 参数取值错误。
目录