1. 接口描述
域名：monitor.api.qcloud.com
接口：GetMonitorData
查询 Ckafka 产品实例监控数据，入参取值如下：
namespace：qce/ckafka
维度名称取值：instanceId
dimensions.0.name=instanceId
dimensions.0.value=实例 ID
2. 输入参数
以下请求参数列表仅列出了接口请求参数，正式调用时需要加上公共请求参数，见 公共请求参数 页面。其中，此接口的 Action 字段为 GetMonitorData。
2.1 输入参数
| 参数名称 | 必选 | 类型 | 输入内容 | 描述 |
|---|---|---|---|---|
| namespace | 是 | String | qce/ckafka | 命名空间，每个云产品会有一个命名空间，具体名称见输入内容一栏 |
| metricName | 是 | String | 具体的指标名称 | 指标名称，具体名称见2.2 |
| dimensions.0.name | 是 | String | instanceId | Ckafka 实例 ID |
| dimensions.0.value | 是 | String | 实例 ID | 用户需要查看监控的实例 ID |
| 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 指标名称
| 指标名称 | 含义 | 单位 | 维度 |
|---|---|---|---|
| instance_msg_heap | 实例落磁盘消息量 | MB | instanceId |
| instance_pro_count | 实例生产消息条数 | 条 | instanceId |
| instance_con_count | 实例消费消息条数 | 次 | instanceId |
| instance_pro_req_count | 实例生产请求次数 | 次 | instanceId |
| instance_con_req_count | 实例消费请求次数 | 次 | instanceId |
| instance_msg_count | 实例落磁盘消息条数 | 条 | instanceId |
| instance_pro_flow | 实例生产流量 | MB/min | instanceId |
| instance_con_flow | 实例消费流量 | MB/min | instanceId |
| instance_disk_usage | 实例磁盘占用百分比 | 无，该指标含义为当前磁盘使用容量与磁盘总容量比值 | instanceId |
| instance_max_con_flow | 实例最大消费流量 | MB/s | instanceId |
| instance_max_pro_flow | 实例最大生产流量 | MB/s | instanceId |
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/ckafka &metricName=instance_pro_count &dimensions.0.name=instanceId &dimensions.0.value=ckafka-0la4h4zk &startTime=2016-06-28 14:10:00 &endTime=2016-06-28 14:20:00
输出
{
"code": 0,
"message": "",
"metricName": "instance_pro_count",
"startTime": "2016-06-28 14:10:00",
"endTime": "2016-06-28 14:20:00",
"period": 300,
"dataPoints": [
50,
35,
20
]
}