容器维度

最近更新时间:2019-01-17 14:30:17

1. 接口描述

域名: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 为命名空间名称
dimensions.3.name=podName
dimensions.3.value 为实例名称
dimensions.4.name=containerId
dimensions.4.value 为容器 ID

英文 中文含义
clusterId 请填写 查询集群列表 接口中返回的clusterId(集群的ID)字段
serviceName 请填写 查询服务列表 接口中返回的serviceName(服务名)字段
namespace 请填写 查询服务列表 接口中返回的namespace(命名空间)字段
podName 请填写 查询服务实例列表 接口中返回的name(实例名称)字段
containerId 请填写查询服务实例列表接口中返回的 containerId(容器 ID)字段。注意:容器 ID 只取开头12位即可

2. 输入参数

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

2.1输入参数

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

2.2 指标名称

监控项 指标名称 单位 说明
容器 CPU 使用情况 container_cpu_used 容器CPU使用量
容器 CPU 使用率(占主机) container_cpu_usage_for_node % 容器CPU使用占主机
容器 CPU 使用率(占Request) container_cpu_usage_for_request % 容器CPU使用占Request
容器 CPU 使用率(占Limit) container_cpu_usage_for_limit % 容器CPU使用占Limit
容器内存使用情况 container_mem_used MiB 容器内存使用量
容器内存使用率(占主机) container_mem_usage_for_node % 容器内存使用占主机
容器内存使用率(占Request) container_mem_usage_for_request % 容器内存使用占Request
容器内存使用率(占Limit) container_mem_usage_for_limit % 容器内存使用占Limit
容器磁盘读流量 container_disk_read_traffic KB/s 容器对磁盘读流量
容器磁盘写流量 container_disk_write_traffic KB/s 容器对磁盘写流量
容器磁盘读 IOPS container_disk_read count 容器对磁盘读IOPS
容器磁盘写 IOPS container_disk_write count 容器对磁盘写IOPS

3. 输出参数

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

4. 错误码表

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

5. 示例

输入

https://monitor.api.qcloud.com/v2/index.php?
&公共请求参数
&namespace=qce/docker
&metricName=container_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
&dimensions.3.name=podName
&dimensions.3.value=test-3488000495-nj6s9
&dimensions.4.name=containerId
&dimensions.4.value=01c5509d2b39
&startTime=2017-03-28 14:10:00
&endTime=2016-03-28 15:10:00
&period=60

输出

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