OnsTrendTopicInputTps - 统计消息生产数据

查询一段时间内指定的Topic的消息写入报表数据。

接口说明

注意阿里云提供的OpenAPI属于管控类API,用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成,消息收发的核心数据链路中严禁依赖OpenAPI实现,否则可能会导致链路产生风险。
您可以使用本接口获取在线上环境统计的Topic的消息数据信息,可以根据需要选择查询指定时间段内Topic的写入量或者TPS曲线数据。

如果应用方消息量比较小,间隔不均匀,此时采用TPS查询可能会导致数据不明显,建议使用总量查询。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用加粗字体表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mq:QueryTrendTopicInputTpsRead
  • Ons
    acs:mq:*:*:{#TopicName}
  • Ons
    acs:mq:*:*:{#InstanceId}%{#TopicName}

请求参数

名称类型必填描述示例值
Topicstring

需查询的Topic名称。

test
BeginTimeLong

查询区间的起始时间戳,单位:毫秒。

1570852800000
EndTimeLong

查询区间的终止时间戳,单位:毫秒。

1570868400000
Typeinteger

查询的类型。取值说明如下:

  • 0:查询指定时间段内Topic的写入量。
  • 1:查询指定时间段内Topic的TPS曲线数据。
0
InstanceIdstring

指定的Topic所对应的实例ID。

MQ_INST_111111111111_DOxxxxxx
PeriodLong

采样周期,单位:分钟,取值可为1、5、10。

10

返回参数

名称类型描述示例值
object
RequestIdstring

公共参数,每个请求的ID都是唯一的,可用于排查和定位问题。

E213AD8A-0730-4B3D-A35A-340DA47D****
Dataobject

数据集合。

Recordsarray

采集点信息。

object
Ynumber

纵轴,数据(TPS或者总量)。

0
XLong

横轴,时间戳,单位:毫秒。

1570852800000
XUnitstring

时间戳,单位:毫秒。

time
YUnitstring

纵轴单位。

msg
Titlestring

Table的名称。

MQ_INST_111111111111_DOxxxxxx%test接收总量趋势图

示例

正常返回示例

JSON格式

{
  "RequestId": "E213AD8A-0730-4B3D-A35A-340DA47D****",
  "Data": {
    "Records": [
      {
        "Y": 0,
        "X": 1570852800000
      }
    ],
    "XUnit": "time",
    "YUnit": "msg",
    "Title": "MQ_INST_111111111111_DOxxxxxx%test接收总量趋势图"
  }
}

错误码

访问错误中心查看更多错误码。

控制台操作

除了调用OnsTrendTopicInputTps接口,您还可以通过消息队列RocketMQ版控制台查看指定Topic中生产消息的统计数据。具体操作,请参见Dashboard

阿里云首页 消息队列RocketMQ版 相关技术圈