拉取指标监控数据

最近更新时间:2019-07-24 15:28:11

1. 接口描述

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

获取云产品的监控数据。传入产品的命名空间、对象维度描述和监控指标即可获得相应的监控数据。 接口调用频率限制为:20次/秒,1200次/分钟。 若您需要调用的指标、对象较多,可能存在因限频出现拉取失败的情况,建议尽量将请求按时间维度均摊。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetMonitorData
Version String 公共参数,本接口取值:2018-07-24
Region String 公共参数,详见产品支持的 地域列表
Namespace String 命名空间,每个云产品会有一个命名空间
MetricName String 指标名称,各个云产品的详细指标说明请参阅各个产品监控接口文档
Instances.N Array of Instance 实例对象的维度组合
Period Integer 监控统计周期。默认为取值为300,单位为s
StartTime Timestamp 起始时间,如2018-09-22T19:51:23+08:00
EndTime Timestamp 结束时间,默认为当前时间。 EndTime不能小于EtartTime

3. 输出参数

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

4. 示例

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

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

输入示例

https://monitor.tencentcloudapi.com/?Action=GetMonitorData
&Namespace=QCE/CVM
&MetricName=CPUUsage
&Period=300
&StartTime=2019-02-24T10:51:23+08:00
&EndTime=2019-03-24T20:51:23+08:00
&Instances.0.Dimensions.0.Name=InstanceId
&Instances.0.Dimensions.0.Value=ins-j0hk02zo
&<公共请求参数>

输出示例

{
  "Response": {
    "StartTime": "2018-08-24 10:50:00",
    "EndTime": "2018-08-24 20:50: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利用率监控数据

输入示例

https://monitor.tencentcloudapi.com/?Action=GetMonitorData
&Namespace=QCE/CVM
&MetricName=CPUUsage
&Period=300
&StartTime=2018-09-22T19:51:23+08:00
&EndTime=2018-09-22T20:51:23+08:00
&Instances.0.Dimensions.0.Name=InstanceId
&Instances.0.Dimensions.0.Value=ins-j0hk02zo
&Instances.1.Dimensions.0.Name=InstanceId
&Instances.1.Dimensions.0.Value=ins-o8vv2w10
&<公共请求参数>

输出示例

{
  "Response": {
    "StartTime": "2018-09-22 19:50:00",
    "EndTime": "2018-09-22 20:50: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利用率监控数据

输入示例

https://monitor.tencentcloudapi.com/?Action=GetMonitorData
&Namespace=QCE/CDB
&MetricName=SlowQueries
&Period=300&StartTime=2018-09-22T19:23:07+08:00
&EndTime=2018-09-22T20:23:07+08:00
&Instances.0.Dimensions.0.Name=InstanceId
&Instances.0.Dimensions.0.Value=cdb-k5d6z7p0
&Instances.0.Dimensions.1.Name=InstanceType
&Instances.0.Dimensions.1.Value=2
&<公共请求参数>

输出示例

{
  "Response": {
    "StartTime": "2018-09-22 19:20:00",
    "EndTime": "2018-09-22 20:20: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 Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameterValue 无效的参数值。