使用 OnsTrendGroupOutputTps 查询指定的 Group ID 在一段时间内消费消息的统计信息。

线上环境生成消费数据报表时,可以使用本接口查询指定的 Group ID 在一段时间内的以下统计信息:

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

调试

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

请求参数

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

系统规定参数。取值:OnsTrendGroupOutputTps。

BeginTime Long 1570852800000

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

EndTime Long 1570868400000

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

GroupId String GID_test

需要查询的 Group ID。

Topic String test

需要查询的 Topic 名称。

Type Integer 0

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

  • 0:查询消费消息总量的统计曲线。
  • 1:查询消费消息 TPS 的统计曲线。
InstanceId String MQ_INST_111111111111_DOxxxxxx

需统计数据的 Group ID 所对应的实例 ID。针对有独立命名空间的实例,该参数为必填。

Period Long 10

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

返回数据

名称 类型 示例值 描述
Data Struct

数据集合。

Records Array

采集点信息。

StatsDataDo
X Long 1570867800000

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

Y Float 0

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

Title String MQ_INST_111111111111_DOxxxxxx%test@MQ_INST_111111111111_DOxxxxxx%GID_test 投递 总量 趋势图

Table 的名称。

XUnit String time

时间戳,单位:毫秒。

YUnit String msg

数量。

RequestId String CE57AEDC-8FD2-43ED-8E3B-1F8780779FE2

为公共参数,每个请求的 ID 都是唯一的。

示例

请求示例

http(s)://[Endpoint]/?Action=OnsTrendGroupOutputTps
&BeginTime=1570852800000
&EndTime=1570868400000
&GroupId=GID_test
&Topic=test
&Type=0
&<公共请求参数>

正常返回示例

XML 格式

<OnsTrendGroupOutputTpsResponse>
  <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>1570855200000</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>数量</YUnit>
        <Title>MQ_INST_111111111111_DOxxxxxx%test@MQ_INST_111111111111_DOxxxxxx%GID_test 投递 总量 趋势图</Title>
  </Data>
  <RequestId>CE57AEDC-8FD2-43ED-8E3B-1F8780779FE2</RequestId>
</OnsTrendGroupOutputTpsResponse>

JSON 格式

{
	"Data": {
		"Records": {
			"StatsDataDo": [
				{
					"Y": 0,
					"X": 1570852800000
				},
				{
					"Y": 0,
					"X": 1570853400000
				},
				{
					"Y": 0,
					"X": 1570854000000
				},
				{
					"Y": 0,
					"X": 1570854600000
				},
				{
					"Y": 0,
					"X": 1570855200000
				},
				{
					"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": "数量",
		"Title": "MQ_INST_111111111111_DOxxxxxx%test@MQ_INST_111111111111_DOxxxxxx%GID_test 投递 总量 趋势图"
	},
	"RequestId": "CE57AEDC-8FD2-43ED-8E3B-1F8780779FE2"
}

错误码

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