调用OnsTrendGroupOutputTps查询指定的Group ID在一段时间内消费消息的统计信息。
使用说明
线上环境生成消费数据报表时,可以使用本接口查询指定的Group ID在一段时间内的以下统计信息:
- 消费消息总量的统计曲线
- 消费消息TPS的统计曲线
QPS限制
本接口的单用户QPS限制为15次/分钟。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
授权信息
默认仅限阿里云账号使用本接口,RAM用户只有在被授予了相关API操作权限后方可使用。本接口的授权信息如下表所示。更多信息,请参见权限策略和示例。
API |
Action |
Resource(有命名空间) |
Resource(无命名空间) |
---|---|---|---|
OnsTrendGroupOutputTps |
mq:QueryTrendGroupOutputTps |
acs:mq:*:*:{instanceId}%{groupId} |
acs:mq:*:*:{groupId} |
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | OnsTrendGroupOutputTps |
系统规定参数。取值:OnsTrendGroupOutputTps。 |
BeginTime | Long | 是 | 1570852800000 |
查询区间的起始时间戳,单位:毫秒。 |
EndTime | Long | 是 | 1570868400000 |
查询区间的终止时间戳,单位:毫秒。 |
GroupId | String | 是 | GID_test |
需要查询的Group ID。 |
InstanceId | String | 是 | MQ_INST_111111111111_DOxxxxxx |
需统计数据的Group ID所对应的实例ID。 |
Topic | String | 是 | test |
需要查询的Topic名称。 |
Type | Integer | 是 | 0 |
查询的类型。取值说明如下:
|
Period | Long | 否 | 10 |
采样周期,单位:分钟,取值可为 1、5、10。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Data | Struct |
数据集合。 |
|
Records | Array of StatsDataDo |
采集点信息。 |
|
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-1F878077**** |
公共参数,每个请求的ID都是唯一的,可用于排查和定位问题。 |
示例
请求示例
http(s)://ons.cn-hangzhou.aliyuncs.com/?Action=OnsTrendGroupOutputTps
&BeginTime=1570852800000
&EndTime=1570868400000
&GroupId=GID_test
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&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-1F878077****</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-1F878077****"
}
错误码
访问错误中心查看更多错误码。
控制台操作
除了调用OnsTrendGroupOutputTps接口,您还可以通过消息队列RocketMQ版控制台查看指定Group ID下的消费消息的统计数据。具体操作,请参见资源报表。
在文档使用中是否遇到以下问题
更多建议
匿名提交