文档中心 云监控 API 文档 各产品监控接口 消息队列 CMQ-队列服务监控接口

消息队列 CMQ-队列服务监控接口

最近更新时间:2019-08-16 22:38:52

1. 接口描述

接口:GetMonitorData
接口请求域名: monitor.tencentcloudapi.com

获取云产品的监控数据。传入产品的命名空间、对象维度描述和监控指标即可获得相应的监控数据。

接口调用频率限制为:20次/秒,1200次/分钟。 单请求最多可支持批量拉取10个实例的监控数据,单请求的数据点数限制为1440个。

若您需要调用的指标、对象较多,可能存在因限频出现拉取失败的情况,建议尽量将请求按时间维度均摊。

查询消息队列CMQ队列服务监控数据,入参取值如下:
&Namespace= QCE/CMQ
&Instances.N.Dimensions.0.Name=queueId
&Instances.N.Dimensions.0.Value=为 CMQ 队列实例 ID
&Instances.N.Dimensions.1.Name=queueName
&Instances.N.Dimensions.1.Value=为 CMQ 队列实例名称

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,正式调用时需要加上公共请求参数,见公共请求参数页面。

2.1输入参数

2.1.1 输入参数总览

参数名称 是否必选 类型 描述
Action String 公共参数,本接口取值:GetMonitorData
Version String 公共参数,本接口取值: 2018-07-24
Region String 公共参数,表示查询的是哪个地域实例的监控数据;支持的地域可查看云服务器支持的地域列表
Namespace String 命名空间,每个云产品会有一个命名空间,API 3.0接口版本的必须是大写,如: QCE/CMQ
MetricName String 指标名称,具体名称见2.2
Instances.N Array of Instance 实例对象的维度组合
Period Integer 监控统计周期。默认为取值为300,单位为s
StartTime Timestamp 起始时间,如"2016-01-01 10:25:00"。 默认时间为当天的”00:00:00”
EndTime Timestamp 结束时间,默认为当前时间。 endTime不能小于startTime

2.1.2 各维度对应参数总览

参数名称 维度名称 维度解释 格式
Instances.N.Dimensions.0.Name queueId 入参为 CMQ 队列实例 ID String类型维度名称:queueId
Instances.N.Dimensions.0.Value queueId 具体的 CMQ 队列实例 ID 输入具体 queueId,如 queue-3abkyggi
Instances.N.Dimensions.1.Name queueName 入参为 CMQ 队列实例名称 String类型维度名称:queueName
Instances.N.Dimensions.1.Value queueName 具体的 CMQ 队列实例名称 输入具体 queueName如 test1

2.2 指标名称

每个指标对应的统计粒度(Period)及维度 (dimension) 可取值不一定相同,可通过DescribeBaseMetrics接口获取每个指标支持的统计粒度及维度信息。

指标名称 含义 单位 维度
InvisibleMsgNum 队列不可见消息数量 queueId、queueName
VisibleMsgNum 队列可见消息数量 queueId、queueName
SendMsgReqCount 发送消息请求量 queueId、queueName
SendMsgNum 发送的消息数量 queueId、queueName
RecvMsgReqCount 接收消息请求量 queueId、queueName
RecvMsgNum 接收的消息数量 queueId、queueName
RecvNullMsgNum 接收空消息的数量 queueId、queueName
BatchRecvNullMsgNum 批量接收空消息的数量 queueId,queueName
DelMsgReqCount 删除消息的请求量 queueId、queueName
DelMsgNum 删除消息的数量 queueId、queueName
SendMsgSize 发送的消息大小 MB queueId、queueName
BatchSendMsgSize 批量发送的消息大小 MB queueId、queueName
BatchSendMsgReqCount 批量发送消息的请求量 queueId、queueName
BatchRecvMsgReqCount 批量接收消息的请求量 queueId、queueName
BatchDelMsgReqCount 批量删除消息的请求量 queueId、queueName
MsgHeapNum 堆积消息的数量 queueId、queueName
LanOuttraffic 内网请求的出流量 MB queueId、queueName
WanOuttraffic 公网请求的出流量 MB queueId、queueName

3. 输出参数

参数名称 类型 描述
MetricName String 监控指标
StartTime Timestamp 数据点起始时间
EndTime Timestamp 数据点结束时间
Period Integer 数据统计周期
DataPoints Array of PointsObject 监控数据列表
RequestId String 唯一请求ID,每次请求都会返回。定位问题时需要提供该次请求的RequestId。

4. 错误码表

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

5. 示例

示例1 拉取单个消息队列CMQ队列服务的队列不可见消息数量监控数据示例

拉取某个消息队列CMQ队列服务某段时间内统计周期为300秒的队列不可见消息数量监控数据

输入示例

https://monitor.tencentcloudapi.com/?Action=GetMonitorData
&Namespace= QCE/CMQ
&MetricName=InvisibleMsgNum
&Period=300
&StartTime=2019-05-08T10:40:00+08:00
&EndTime=2018-05-08T10:50:00+08:00
&Instances.0.Dimensions.0.Name=queueId
&Instances.0.Dimensions.0.Value=queue-123456
&Instances.0.Dimensions.1.Name=queueName
&Instances.0.Dimensions.1.Value=queue_abcdef
&[<公共请求参数>](https://cloud.tencent.com/document/api/248/4478)

输出示例

{
  "Response": {
    "StartTime": "2019-05-08 10:40:00",
    "EndTime": "2019-05-08 10:50:00",
    "Period": 300,
    "MetricName": "InvisibleMsgNum",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "queueId",
            "Value": "queue-123456"
          },
          {
            "Name": "queueName",
            "Value": "queue_abcdef"
          }
        ],
        "Timestamps": [
          1559011200,
          1559011500,
          1559011800
        ],
        "Values": [
          0,
          0,
          0
        ]
      }
    ],
    "RequestId": "e1440ace-c2a2-4e93-8110-8dcaefdd4f1a"
  }
}

示例2 拉取多个消息队列CMQ队列服务的队列不可见消息数量监控数据示例

拉取多个消息队列CMQ队列服务某段时间内统计周期为300秒的队列不可见消息数量监控数据

输入示例

https://monitor.tencentcloudapi.com/?Action=GetMonitorData
&Namespace=QCE/CMQ
&MetricName=InvisibleMsgNum
&Period=300
&StartTime=2019-05-08T16:40:00+08:00
&EndTime=2018-05-08T16:45:00+08:00
&Instances.0.Dimensions.0.Name=queueId
&Instances.0.Dimensions.0.Value=queue-123456
&Instances.0.Dimensions.1.Name=queueName
&Instances.0.Dimensions.1.Value=queue_abcdef
&Instances.1.Dimensions.0.Name=queueId
&Instances.1.Dimensions.0.Value=queue-1234567
&Instances.1.Dimensions.1.Name=queueName
&Instances.1.Dimensions.1.Value=queue_abcdefg
&<公共请求参数>

输出示例

{
  "Response": {
    "StartTime": "2019-05-08 10:40:00",
    "EndTime": "2019-05-08 10:50:00",
    "Period": 300,
    "MetricName": "InvisibleMsgNum",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "queueId",
            "Value": "queue-123456"
          },
          {
            "Name": "queueName",
            "Value": "queue_abcdef"
          }
        ],
        "Timestamps": [
          1559011200,
          1559011500,
          1559011800
        ],
        "Values": [
          0,
          0,
          0
        ]
      },
      {
        "Dimensions": [
          {
            "Name": "queueId",
            "Value": "queue-1234567"
          },
          {
            "Name": "queueName",
            "Value": "queue_abcdefg"
          }
        ],
        "Timestamps": [
          1559011200,
          1559011500,
          1559011800
        ],
        "Values": [
          0,
          0,
          0
        ]
      }
    ],
    "RequestId": "e1440ace-c2a2-4e93-8110-8dcaefdd4f1a"
  }
}