1. 接口描述
接口请求域名： monitor.api3.fincloud.tencent.cn。
获取云产品的监控数据。传入产品的命名空间、对象维度描述和监控指标即可获得相应的监控数据。
接口调用频率限制为：20次/秒，1200次/分钟。
若您需要调用的指标、对象较多，可能存在因限频出现拉取失败的情况，建议尽量将请求按时间维度均摊。
默认接口请求频率限制：20次/秒。
接口更新时间：2022-11-30 19:22:03。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：GetMonitorData |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-07-24 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| Namespace | 是 | 否 | String | 命名空间 示例值： QCE/CVM |
| MetricName | 是 | 否 | String | 指标名称 示例值： CpuUsage |
| Period | 否 | 否 | Uint64 | 周期， 示例值： 60 |
| StartTime | 否 | 否 | Datetime_iso | 起始时间，如2018-09-22T19:51:23+08:00 示例值： 2019-03-24T10:51:23+08:00 |
| EndTime | 否 | 否 | Datetime_iso | 结束时间，如2018-09-22T20:51:23+08:00，默认为当前时间。 EndTime不能小于StartTime 示例值： 2019-03-24T20:51:23+08:00 |
| Instances | 是 | 否 | Array of Instance | 实例对象的维度组合，格式为key-value键值对形式的集合。 示例值：查看 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Period | Uint64 | 统计周期 示例值： 300 |
| MetricName | String | 指标名 示例值： cpu_usage |
| DataPoints | Array of DataPoint | 数据点数组 示例值：查看 |
| StartTime | Datetime | 开始时间 示例值： 2019-03-24T10:50:00+08:00 |
| EndTime | Datetime | 结束时间 示例值： 2019-03-24T20:50:00+08:00 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue | 无效的参数值。 |
| InternalError | 内部错误。 |
5. 示例
示例1 拉取单台云服务器监控数据
拉取某台云服务器某段时间内统计周期为5分钟的CPU利用率监控数据
输入示例
https://monitor.api3.fincloud.tencent.cn/?Action=GetMonitorData
&Namespace=QCE/CVM
&MetricName=CPUUsage
&Period=300
&StartTime=2019-03-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": "2019-03-24 10:50:00",
"EndTime": "2019-03-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 拉取单台CDB监控数据
拉取某台CDB实例某段时间内统计周期为5分钟的CPU利用率监控数据
输入示例
https://monitor.api3.fincloud.tencent.cn/?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"
}
}
示例3 拉取多台云服务器监控数据
拉取多台云服务器某段时间内统计周期为5分钟的CPU利用率监控数据
输入示例
https://monitor.api3.fincloud.tencent.cn/?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"
}
}