文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>腾讯云可观测平台

服务维度

最近更新时间：2020-02-14 10:40:26

我的收藏

本页目录：

接口描述

域名：monitor.api.qcloud.com 接口：GetMonitorData
腾讯云容器服务为用户解决容器集群的搭建以及运维管理工作，无缝衔接了腾讯云的计算、网络、存储、监控、安全能力，帮助用户升级开发模式、变更应用交付、重构数据管理方式。助力企业快速上云、提速应用部署、简化集群管理，将精力花在刀刃上。具体介绍请参考 容器服务产品概述。
查询容器服务 - 服务维度监控数据，入参取值如下： namespace：qce/docker dimensions.0.name=clusterId dimensions.0.value 为集群 ID dimensions.1.name=serviceName dimensions.1.value 为服务名称 dimensions.2.name=namespace dimensions.2.value 为命名空间名称
英文
中文含义
clusterId
请填写 查询集群列表 接口中返回的 clusterId（集群的 ID） 字段
serviceName
请填写 查询服务列表 接口中返回的 serviceName（服务名）字段
namespace
请填写 查询服务列表 接口中返回的 namespace（命名空间）字段

输入参数

以下请求参数列表仅列出了接口请求参数，正式调用时需要加上公共请求参数，见 公共请求参数 文档。其中，此接口的 Action 字段为 GetMonitorData。

输入参数

参数名称
必选
类型
输入内容
描述
namespace
是
String
qce/cvm
命名空间，每个云产品会有一个命名空间，具体名称见输入内容一栏。
metricName
是
String
具体的指标名称
dimensions.n.name
是
String
维度的名称
维度的名称，具体维度名称见 接口描述，与 dimensions.n.value 配合使用。
dimensions.n.value
是
String
对应的维度的值
对应的维度的值，具体维度名称见 接口描述，与dimensions.n.name配合使用。
period
否
Int
60/300
监控统计周期，绝大部分指标支持60s统计粒度，部分指标仅支持300s统计粒度，统计粒度根据指标的不同而变。输入参数时可参考 指标名称 的指标详情列表。
startTime
否
Datetime
起始时间
起始时间，如"2016-01-01 10:25:00"。 默认时间为当天的"00:00:00"
endTime
否
Datetime
结束时间
结束时间，默认为当前时间。endTime 不能小于 startTime

指标名称

监控项
指标名称
单位
说明
服务CPU使用情况
service_cpu_used
核
服务内所有容器实例 CPU 使用之和
服务CPU使用率（占集群）
service_cpu_usage_for_cluster
%
服务使用 CPU 占集群比率
服务内存使用情况
service_mem_used
MiB
服务内所有容器实例内存使用之和
服务内存使用率（占集群）
service_mem_usage_for_cluster
%
服务使用内存占集群比率
服务网络入流量
service_in_flux
MB
服务内所有实例在该时间窗口入流量之和
服务网络出流量
service_out_flux
MB
服务内所有实例在该时间窗口出流量之和
服务网络入带宽
service_in_bandwidth
Mbps
服务内所有实例的入带宽之和
服务网络出带宽
service_out_bandwidth
Mbps
服务内所有实例的出带宽之和
服务网络入包量
service_in_packets
个/s
服务内所有实例的入包量之和
服务网络出包量
service_out_packets
个/s
服务内所有实例的出包量之和

输出参数

参数名称
类型
描述
code
Int
错误码，0：成功，其他值表示失败
message
String
返回信息
startTime
Datetime
起始时间
endTime
Datetime
结束时间
metricName
String
指标名称
period
Int
监控统计周期
dataPoints
Array
监控数据列表

错误码表

错误代码
错误描述
英文描述
-502
资源不存在
OperationDenied.SourceNotExists
-503
请求参数有误
InvalidParameter
-505
参数缺失
InvalidParameter.MissingParameter
-507
超出限制
OperationDenied.ExceedLimit
-509
错误的维度组合
InvalidParameter.DimensionGroupError
-513
DB 操作失败
InternalError.DBoperationFail

示例

输入

https://monitor.api.qcloud.com/v2/index.php?
&<公共请求参数>
&namespace=qce/docker
&metricName=service_cpu_used
&dimensions.0.name=clusterId
&dimensions.0.value=cls-xxxxx
&dimensions.1.name=serviceName
&dimensions.1.value=test
&dimensions.2.name=namespace
&dimensions.2.value=default
&startTime=2017-03-28 14:10:00
&endTime=2016-03-28 15:10:00
&period=60


输出

{
    "code": 0,
    "message": "",
    "metricName": "service_cpu_used",
    "startTime": "2017-03-28 14:10:00",
    "endTime": "2016-03-28 15:10:00",
    "period": 60,
    "dataPoints": [
        30,
        35,
        40
    ]
}

中国站
目录