文档中心 API 中心 云监控 各产品监控接口 消息队列 Ckafka-主题监控接口

消息队列 Ckafka-主题监控接口

最近更新时间:2019-06-27 20:07:29

1. 接口描述

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

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

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

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

查询消息队列主题监控数据,入参取值如下:
&Namespace=QCE/CKAFKA
&Instances.N.Dimensions.0.Name=instanceId
&Instances.N.Dimensions.0.Value=实例 ID
&Instances.N.Dimensions.1.Name=topicId
&Instances.N.Dimensions.1.Value=主题 ID

2. 输入参数

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

2.1输入参数

2.1.1输入参数总览

参数名称 是否必选 类型 描述
Action String 公共参数,本接口取值:GetMonitorData
Version String 公共参数,本接口取值: 2018-07-24
Region String 公共参数,表示查询的是哪个地域实例的监控数据;支持的地域可查看云服务器支持的 地域列表
Namespace String 命名空间,每个云产品会有一个命名空间,API 3.0接口版本的必须是大写,如: QCE/CKAFKA
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 instanceId instanceId String 类型维度名称:instanceId
Instances.N.Dimensions.0.Value instanceId ckafka 实例的 ID 具体实例名称,如ckafka-test
Instances.N.Dimensions.1.Name topicId topicId String 类型维度名称:topicId
Instances.N.Dimensions.1.Value topicId 实例所在主题的 ID 具体主题 ID,如 topic-test

2.2 指标名称

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

指标名称 含义 单位 维度
CtopicProFlow       主题生产流量   MB   instanceId,topicId  
CtopicConFlow   主题消费流量 MB   instanceId,topicId  
CtopicMsgHeap     主题落磁盘消息数量 MB   instanceId,topicId   
CtopicProCount 主题生产消息数量 条   instanceId,topicId          
CtopicProReqCount      主题生产请求次数   次   instanceId,topicId  
CtopicConReqCount   主题消费请求次数 次   instanceId,topicId  
CtopicMsgCount     主题落磁盘消息数 条   instanceId,topicId   
CtopicConCount 主题消费消息数量 条   instanceId,topicId          

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

拉取某个消息队列主题某段时间内统计周期为60秒的主题生产流量监控数据。

输入示例

https://monitor.tencentcloudapi.com/?Action=GetMonitorData
&Namespace=QCE/CKAFKA
&MetricName=CtopicProFlow
&Period=60
&StartTime=2019-05-08T16:40:00+08:00
&EndTime=2018-05-08T16:45:00+08:00
&Instances.0.Dimensions.0.Name=instanceId
&Instances.0.Dimensions.0.Value=ckafka-test
&Instances.0.Dimensions.1.Name=topicId
&Instances.0.Dimensions.1.Value=topic-test
&<公共请求参数>

输出示例

{
  "Response": {
    "StartTime": "2019-05-21 17:00:00",
    "EndTime": "2019-05-21 17:05:00",
    "Period": 60,
    "MetricName": "CtopicProFlow",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "instanceId",
            "Value": "ckafka-test"
          },
          {
            "Name": "topicId",
            "Value": "topic-test"
          }
        ],
        "Timestamps": [
          1558429200,
          1558429260,
          1558429320,
          1558429380,
          1558429440,
          1558429500
        ],
        "Values": [
          18.213,
          18.219,
          17.911,
          18.243,
          17.916,
          17.939
        ]
      }
    ],
    "RequestId": "68a1ffe1-b314-4da8-8f8c-cdcfcff1d3fd"
  }
}

示例2

拉取多个消息队列主题某段时间内统计周期为60秒的主题生产流量监控数据。

输入示例

https://monitor.tencentcloudapi.com/?Action=GetMonitorData
&Namespace=QCE/CKAFKA
&MetricName=CtopicProFlow
&Period=60
&StartTime=2019-05-08T16:40:00+08:00
&EndTime=2018-05-08T16:45:00+08:00
&Instances.0.Dimensions.0.Name=instanceId
&Instances.0.Dimensions.0.Value=ckafka-test1
&Instances.0.Dimensions.1.Name=topicId
&Instances.0.Dimensions.1.Value=topic-test1
&Instances.1.Dimensions.0.Name=instanceId
&Instances.1.Dimensions.0.Value=ckafka-test2
&Instances.1.Dimensions.1.Name=topicId
&Instances.1.Dimensions.1.Value=topic-test2
&<公共请求参数>

输出示例

{
  "Response": {
    "StartTime": "2019-05-21 17:00:00",
    "EndTime": "2019-05-21 17:05:00",
    "Period": 60,
    "MetricName": "CtopicProFlow",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "instanceId",
            "Value": "ckafka-test1"
          },
          {
            "Name": "topicId",
            "Value": "topic-test1"
          }
        ],
        "Timestamps": [
          1558429200,
          1558429260,
          1558429320,
          1558429380,
          1558429440,
          1558429500
        ],
        "Values": [
          18.213,
          18.219,
          17.911,
          18.243,
          17.916,
          17.939
        ]
      },
      {
        "Dimensions": [
          {
            "Name": "instanceId",
            "Value": "ckafka-test2"
          },
          {
            "Name": "topicId",
            "Value": "topic-test2"
          }
        ],
        "Timestamps": [
          1558429200,
          1558429260,
          1558429320,
          1558429380,
          1558429440,
          1558429500
        ],
        "Values": [
          18.213,
          18.219,
          17.911,
          18.243,
          17.916,
          17.939
        ]
      }
    ],
    "RequestId": "68a1ffe1-b314-4da8-8f8c-cdcfcff1d3fd"
  }
}