查询监控指标：GetMonitorData接口调用使用指南
最近更新时间: 2025-02-18 16:02:00
接口描述
接口名称 版本 接口功能 GetMonitorData 2017-03-12 拉取云产品指标监控数据 输入参数
参数名称 必选 类型 描述 Namespace 是 String 命名空间，如qce/cvm。各个云产品的详细命名空间参阅本文档附录部分
示例值：qce/cvmMetricName 是 String 指标名称，如cpu_usage，仅支持单指标拉取。各个云产品的详细指标说明请参阅本文档附录部分
示例值：cpu_usageDimensions 是 Array 实例对象的维度组合，格式为key-value键值对形式的集合。不同类型的实例字段完全不同，如CVM为[{"unInstanceId": "ins-miltleuc"}]。各个云产品的维度请参阅本文档附录部分，单请求最多支持批量拉取10个实例的监控数据。
示例值：[{"unInstanceId": "ins-miltleuc"},
{"unInstanceId": "ins-4xny0cbt"}]Period 是 Integer 监控统计周期，如60，单位为s。每个指标支持的统计周期不一定相同，各个云产品支持的统计周期请参阅本文档附录部分。单请求的数据点数限制为1440个。
示例值：300StartTime 是 Time 起始时间，如2018-09-22T19:51:23+08:00
示例值：2019-03-24T10:51:23+08:00EndTime 是 Time 结束时间，如2018-09-22T20:51:23+08:00，默认为当前时间。 EndTime不能小于StartTime
示例值：2019-03-24T20:51:23+08:00请求域名
接口请求域名：monitor.api3.${domain_main}，如monitor.api3.3100light2az.fsphere.cn。
说明：
${domain_main}可以通过登录任意一个pod，打开/tce/conf/cm/local.json搜索domain_main关键字来获取。
- 请求地域
由于监控数据是按地域上报并且是按地域存储的，因此调用接口时需明确指定被拉取实例所在的地域，地域信息获取方式为：
登录任意一个pod，打开/tce/conf/cm/local.json搜索region_list关键字，里面的region_name即为可用的地域。
- 调用限频
默认接口请求频率限制：20次/秒。
输出参数
参数名称 类型 描述 MetricName String 指标名
示例值：cpu_usagePeriod Integer 监控统计周期
示例值：60DataPoints[].Dimensions Json 实例对象维度组合
示例值：{"unInstanceId": "ins-miltleuc"}DataPoints[].Points Array 数据点数组 StartTime Time 开始时间
示例值：2019-03-24T10:50:00+08:00EndTime Time 结束时间
示例值：2019-03-24T20:50:00+08:00RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId 示例
拉取某台CVM实例某段时间内统计周期为5分钟的CPU利用率监控数据。
输入示例：
POST HTTP/1.1
Host: monitor.api3.3100light2az.fsphere.cn
Content-Type: application/json
Action: GetMonitorData
{
"Namespace": "qce/cvm",
"MetricName": "CPUUsage",
"Period": 300,
"Dimensions": [
{
"unInstanceId": "ins-miltleuc"
}
],
"StartTime": "2024-03-24T10:51:23+08:00",
"EndTime": "2024-03-24T20:51:23+08:00"
}
输出示例
{
"Response": {
"StartTime": "2019-03-24 10:50:00",
"EndTime": "2019-03-24 20:50:00",
"Period": 300,
"MetricName": "cpu_usage",
"DataPoints": [
{
"Dimensions": {
"unInstanceId": "ins-miltleuc" },
"Points": [
2.566,
2.283,
6.316,
2.816,
2.7,
2.35
]
}
],
"RequestId": "d96ec542-6547-4af2-91ac-fee85c1b8b85"
}
}
- SDK代码调用
拉取某台CVM实例某段时间内统计周期为5分钟的CPU利用率监控数据。
- golang示例
`package main
import ( "fmt"
"github.com/tcecloud/tcecloud-sdk-go/tcecloud/common"
"github.com/tcecloud/tcecloud-sdk-go/tcecloud/common/errors"
"github.com/tcecloud/tcecloud-sdk-go/tcecloud/common/profile"
monitor "github.com/tcecloud/tcecloud-sdk-go/tcecloud/monitor/v20170312")
func main() { secretId := "AKIDxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" secretKey := "eyzi69sGK3SWFeiblb8NKwD9l2yZplNf"
credential := common.NewCredential(secretId, secretKey)
cpf := profile.NewClientProfile()
cpf.HttpProfile.Scheme = "HTTP"
cpf.HttpProfile.ReqTimeout = 10
cpf.HttpProfile.Endpoint = "monitor.api3.3100light2az.fsphere.cn"
client, _ := monitor.NewClient(credential, "chongqing", cpf)
request := monitor.NewGetMonitorDataRequest()
request.Namespace = common.StringPtr("qce/cvm")
request.MetricName = common.StringPtr("cpu_usage")
request.Period = common.Uint64Ptr(60)
request.StartTime = common.StringPtr("2024-10-17T15:10:42+08:00")
request.EndTime = common.StringPtr("2024-10-17T16:10:42+08:00")
// 构建 Dimensions 字段
dimensions := []string{
"{\"unInstanceId\": \"ins-miltleuc\"}",
}
request.Dimensions = common.StringPtrs(dimensions)
response, err := client.GetMonitorData(request)
if _, ok := err.(*errors.CloudSDKError); ok {
fmt.Printf("An API error has returned: %s", err)
return
}
// Non-SDK exception, direct failure. Other processing can be added to the actual code.
if err != nil {
panic(err)
}
// Print the returned json string
fmt.Printf("%s", response.ToJsonString())}
`
说明：
13~14行：secretId、secretKey为调用凭证，用于调用鉴权，相当于通过secretId和secretKey可以识别调用的appid及uin。secretId与secretKey通过如下方式进行创建：
20行：Endpoint为调用域名，获取方式参考第三节"3. 请求域名"
21行：chongqing为云产品实例监控数据所在的地域，获取方式参考第四节"4. 请求地域"
- python示例
`# -- coding: utf8 -- # import json from tcecloud.common import credential from tcecloud.common.exception.cloud_sdk_exception import CloudSDKException from tcecloud.monitor.v20170312 import monitor_client, models from tcecloud.common.profile.client_profile import ClientProfile from tcecloud.common.profile.http_profile import HttpProfile import ssl
ssl._create_default_https_context = ssl._create_unverified_context
try: secret_id = "AKIDxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" secret_key = "1qVuzkBH3WgWhX3F7LJyJJyIJ0NP77rM" cred = credential.Credential(secret_id, secret_key)
httpProfile = HttpProfile()
httpProfile.endpoint = "monitor.api3.3100light2az.fsphere.cn"
clientProfile = ClientProfile()
clientProfile.httpProfile = httpProfile
client = monitor_client.MonitorClient(cred, "chongqing", clientProfile)
req = models.GetMonitorDataRequest()
params = {
"Namespace": "qce/cvm",
"MetricName": "cpu_usage",
"Period": 60,
"StartTime": "2024-10-17T15:10:42+08:00",
"EndTime": "2024-10-17T16:10:42+08:00",
"Dimensions": ['''{"unInstanceId": "ins-miltleuc"}''']
}
req.from_json_string(json.dumps(params))
resp = client.GetMonitorData(req)
# Output json format string back package
print(resp.to_json_string(indent=2))except CloudSDKException as err: print(err) `
说明：
14~15行：secretId、secretKey为调用凭证，用于调用鉴权，相当于通过secretId和secretKey可以识别调用的appid及uin。secretId与secretKey通过如下方式进行创建：
19行：Endpoint为调用域名，获取方式参考第三节"3. 请求域名"
23行：chongqing为云产品实例监控数据所在的地域，获取方式参考第四节"4. 请求地域"
- 附录
命名空间 指标名 指标中文名 时间粒度 维度组合 维度组合示例 qce/cvm cpu_usage CPU 利用率 60/300/3600/86400 unInstanceId "unInstanceId":"ins-096makkh" cpu_loadavg CPU 一分钟平均负载 60/300/3600/86400 unInstanceId "unInstanceId":"ins-096makkh" CPULoadAvg5m CPU 五分钟平均负载 60/300/3600/86400 unInstanceId "unInstanceId":"ins-096makkh" CPULoadAvg15m CPU 十五分钟平均负载 60/300/3600/86400 unInstanceId "unInstanceId":"ins-096makkh" base_cpu_usage 基础 CPU 使用率 60/300/3600/86400 unInstanceId "unInstanceId":"ins-096makkh" gpu_mem_total GPU 内存总量 60/300/3600/86400 unInstanceId "unInstanceId":"ins-096makkh" GpuMemUsage GPU 内存使用率 60/300/3600/86400 unInstanceId "unInstanceId":"ins-096makkh" gpu_mem_used GPU 内存使用量 60/300/3600/86400 unInstanceId "unInstanceId":"ins-096makkh" GpuPowDraw GPU 功耗使用量 60/300/3600/86400 unInstanceId "unInstanceId":"ins-096makkh" GpuPowLimit GPU 功耗总量 60/300/3600/86400 unInstanceId "unInstanceId":"ins-096makkh" GpuPowUsage GPU 功耗使用率 60/300/3600/86400 unInstanceId "unInstanceId":"ins-096makkh" GpuTemp GPU 温度 60/300/3600/86400 unInstanceId "unInstanceId":"ins-096makkh" GpuUtil GPU 使用率 60/300/3600/86400 unInstanceId "unInstanceId":"ins-096makkh" lan_outtraffic 内网出带宽 60/300/3600/86400 unInstanceId "unInstanceId":"ins-096makkh" lan_intraffic 内网入带宽 60/300/3600/86400 unInstanceId "unInstanceId":"ins-096makkh" lan_outpkg 内网出包量 60/300/3600/86400 unInstanceId "unInstanceId":"ins-096makkh" lan_inpkg 内网入包量 60/300/3600/86400 unInstanceId "unInstanceId":"ins-096makkh" tcp_curr_estab TCP 连接数 60/300/3600/86400 unInstanceId "unInstanceId":"ins-096makkh" mem_used 内存使用量 60/300/3600/86400 unInstanceId "unInstanceId":"ins-096makkh" mem_usage 内存利用率 60/300/3600/86400 unInstanceId "unInstanceId":"ins-096makkh" qce/lb_private outtraffic LB 到后端的出带宽 60/300/3600/86400 vip "vip":"111.111.111.11" intraffic LB 到后端的入带宽 60/300/3600/86400 vip "vip":"111.111.111.11" outpkg LB 到后端的出包量 60/300/3600/86400 vip "vip":"111.111.111.11" inpkg LB 到后端的入包量 60/300/3600/86400 vip "vip":"111.111.111.11" connum LB 到后端的连接数 60/300/3600/86400 vip "vip":"111.111.111.11" new_conn LB 到后端的新建连接数 60/300/3600/86400 vip "vip":"111.111.111.11"