主题订阅

最近更新时间:2019-03-15 15:06:12

1. 接口描述

域名:monitor.api.qcloud.com
接口:GetMonitorData

腾讯云消息服务(Cloud Message Queue)是分布式消息队列服务,能够为分布式部署的不同应用之间或者一个应用的不同组件之间,提供基于消息的可靠的异步通信机制,消息被存储在高可靠、高可用的 CMQ 队列中,多进程可以同时读写,互不干扰。
CMQ 分为两种模型:queue 和 topic,该接口文档介绍主题模式的监控指标拉取。

2. 输入参数

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

2.1 输入参数

参数名称 必选 类型 输入内容 描述
namespace String qce/cmqtopic 命名空间,每个云产品会有一个命名空间。
metricName String 具体的指标名称 指标名称,具体名称见 指标名称
dimensions.0.name String topicId 入参为 CMQ 主题实例 id。
dimensions.0.value String 具体的 CMQ 主题实例 ID 输入具体 topicId,如 topic-i4p4k0u0。
dimensions.1.name String subscriptionId 入参为 CMQ 订阅实例 ID,当 指标名称 中指标对应的维度为 topicId、subscriptionId 时,该字段必选 。
dimensions.1.value String 具体的 CMQ 订阅实例 ID 输入具体 subscriptionId,如 test1, 当 指标名称 中指标对应的维度为 topicId、subscriptionId 时,该字段必选 。
period Int 60/300 监控统计周期,绝大部分指标支持60s统计粒度,部分指标仅支持300s统计粒度,统计粒度根据指标的不同而变。输入参数时可参考 指标名称 的指标详情列表。
startTime Datetime 起始时间 起始时间,如"2016-01-01 10:25:00"。 默认时间为当天的”00:00:00”。
endTime Datetime 结束时间 结束时间,默认为当前时间。endTime 不能小于 startTime。

2.2 指标名称

指标名称 含义 单位 维度
NumOfMsgPublished 已发布消息的数量 topicId
NumOfMsgBatchPublished 批量已发布消息的数量 topicId
CountOfMsgPublished 已发布消息的请求量 topicId
CountOfMsgBatchPublished 批量已发布消息的请求量 topicId
PublishSize 已发布消息的大小 MB topicId
BatchPublishSize 批量已发布消息的大小 MB topicId
msgHeapNum 堆积消息的数量 topicId
lanOuttraffic 内网请求的出流量 MB topicId
wanOuttraffic 外网请求的出流量 MB topicId
NumOfNotify 总投递消息的数量 topicId、subscriptionId
NumOfSuccNotify 成功投递消息的数量 topicId、subscriptionId

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/cmqtopic
&metricName=NumOfMsgPublished
&dimensions.0.name=topicId
&dimensions.0.value=topic-06c1jrku
&startTime=2016-06-28 14:10:00
&endTime=2016-06-28 14:20:00

输出

{
    "code": 0,
    "message": "",
    "metricName": "NumOfMsgPublished",
    "startTime": "2016-06-28 14:10:00",
    "endTime": "2016-06-28 14:20:00",
    "period": 300,
    "dataPoints": [
        50,
        35,
        20
    ]
}