调用OnsTrendTopicInputTps查询一段时间内指定Topic的生产消息的统计数据。

使用说明

您可以使用本接口获取在线上环境统计的Topic的消息数据信息,可以根据需要选择查询指定时间段内Topic的写入量或者TPS曲线数据。

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

QPS限制

本接口的单用户QPS限制为15次/分钟。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

授权信息

默认仅限阿里云账号使用本接口,RAM用户只有在被授予了相关API操作权限后方可使用。本接口的授权信息如下表所示。更多信息,请参见权限策略和示例

API

Action

Resource(有命名空间)

Resource(无命名空间)

OnsTrendTopicInputTps

mq:QueryTrendTopicInputTps

acs:mq:*:*:{instanceId}%{topic}

acs:mq:*:*:{topic}

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String OnsTrendTopicInputTps

系统规定参数。取值:OnsTrendTopicInputTps

BeginTime Long 1570852800000

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

EndTime Long 1570868400000

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

InstanceId String MQ_INST_111111111111_DOxxxxxx

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

Topic String test

需查询的Topic名称。

Type Integer 0

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

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

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

返回数据

名称 类型 示例值 描述
Data Struct

数据集合。

Records Array of StatsDataDo

采集点信息。

StatsDataDo
X Long 1570852800000

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

Y Float 0

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

Title String MQ_INST_111111111111_DOxxxxxx%test 接收 总量 趋势图

Table的名称。

XUnit String time

时间戳,单位:毫秒。

YUnit String msg

纵轴单位。

RequestId String E213AD8A-0730-4B3D-A35A-340DA47D****

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

示例

请求示例

http(s)://ons.cn-hangzhou.aliyuncs.com/?Action=OnsTrendTopicInputTps
&BeginTime=1570852800000
&EndTime=1570868400000
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&Topic=test
&Type=0
&<公共请求参数>

正常返回示例

XML格式

<OnsTrendTopicInputTpsResponse>
  <Data>
        <Records>
              <StatsDataDo>
                    <Y>0</Y>
                    <X>1570852800000</X>
              </StatsDataDo>
              <StatsDataDo>
                    <Y>0</Y>
                    <X>1570853400000</X>
              </StatsDataDo>
              <StatsDataDo>
                    <Y>0</Y>
                    <X>1570854000000</X>
              </StatsDataDo>
              <StatsDataDo>
                    <Y>0</Y>
                    <X>1570854600000</X>
              </StatsDataDo>
              <StatsDataDo>
                    <Y>0</Y>
                    <X>1570860600000</X>
              </StatsDataDo>
              <StatsDataDo>
                    <Y>0</Y>
                    <X>1570861200000</X>
              </StatsDataDo>
              <StatsDataDo>
                    <Y>0</Y>
                    <X>1570861800000</X>
              </StatsDataDo>
              <StatsDataDo>
                    <Y>0</Y>
                    <X>1570862400000</X>
              </StatsDataDo>
              <StatsDataDo>
                    <Y>0</Y>
                    <X>1570863000000</X>
              </StatsDataDo>
              <StatsDataDo>
                    <Y>0</Y>
                    <X>1570863600000</X>
              </StatsDataDo>
              <StatsDataDo>
                    <Y>0</Y>
                    <X>1570864200000</X>
              </StatsDataDo>
              <StatsDataDo>
                    <Y>1</Y>
                    <X>1570864800000</X>
              </StatsDataDo>
              <StatsDataDo>
                    <Y>0</Y>
                    <X>1570865400000</X>
              </StatsDataDo>
              <StatsDataDo>
                    <Y>0</Y>
                    <X>1570866000000</X>
              </StatsDataDo>
              <StatsDataDo>
                    <Y>0</Y>
                    <X>1570866600000</X>
              </StatsDataDo>
              <StatsDataDo>
                    <Y>0</Y>
                    <X>1570867200000</X>
              </StatsDataDo>
              <StatsDataDo>
                    <Y>0</Y>
                    <X>1570867800000</X>
              </StatsDataDo>
              <StatsDataDo>
                    <Y>0</Y>
                    <X>1570868400000</X>
              </StatsDataDo>
        </Records>
        <XUnit>time</XUnit>
        <YUnit>msg</YUnit>
        <Title>MQ_INST_111111111111_DOxxxxxx%test-mq_topic 接收 总量 趋势图</Title>
  </Data>
  <RequestId>E213AD8A-0730-4B3D-A35A-340DA47D****</RequestId>
</OnsTrendTopicInputTpsResponse>

JSON格式

{
	"Data": {
		"Records": {
			"StatsDataDo": [
				{
					"Y": 0,
					"X": 1570852800000
				},
				{
					"Y": 0,
					"X": 1570853400000
				},
				{
					"Y": 0,
					"X": 1570854000000
				},
				{
					"Y": 0,
					"X": 1570854600000
				},
				{
					"Y": 0,
					"X": 1570860600000
				},
				{
					"Y": 0,
					"X": 1570861200000
				},
				{
					"Y": 0,
					"X": 1570861800000
				},
				{
					"Y": 0,
					"X": 1570862400000
				},
				{
					"Y": 0,
					"X": 1570863000000
				},
				{
					"Y": 0,
					"X": 1570863600000
				},
				{
					"Y": 0,
					"X": 1570864200000
				},
				{
					"Y": 1,
					"X": 1570864800000
				},
				{
					"Y": 0,
					"X": 1570865400000
				},
				{
					"Y": 0,
					"X": 1570866000000
				},
				{
					"Y": 0,
					"X": 1570866600000
				},
				{
					"Y": 0,
					"X": 1570867200000
				},
				{
					"Y": 0,
					"X": 1570867800000
				},
				{
					"Y": 0,
					"X": 1570868400000
				}
			]
		},
        "XUnit": "time",
        "YUnit": "msg",
		"Title": "MQ_INST_111111111111_DOxxxxxx%test 接收 总量 趋势图"
	},
	"RequestId": "E213AD8A-0730-4B3D-A35A-340DA47D****"
}

错误码

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

控制台操作

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