调用OnsTrendGroupOutputTps查询Group ID的消费总量与TPS-云消息队列 RocketMQ 版-阿里云

接口说明

重要阿里云提供的 OpenAPI 属于管控类 API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖 OpenAPI 实现，否则可能会导致链路产生风险。

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

消费消息总量的统计曲线
消费消息 TPS 的统计曲线

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

mq:QueryTrendGroupOutputTps

get

Group

acs:mq:{#regionId}:{#accountId}:{#GroupName}

Group

acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#GroupName}

无

mq:OnsInstanceBaseInfo

请求参数

名称	类型	必填	描述	示例值
GroupId	string	是	需要查询的 Group ID。	GID_test
Topic	string	是	需要查询的 Topic 名称。	test
BeginTime	integer	是	查询区间的起始时间戳，单位：毫秒。	1570852800000
EndTime	integer	是	查询区间的终止时间戳，单位：毫秒。	1570868400000
Type	integer	是	查询的类型。取值说明如下： 0：查询消费消息总量的统计曲线。 1：查询消费消息 TPS 的统计曲线。	0
InstanceId	string	否	需统计数据的 Group ID 所对应的实例 ID。	MQ_INST_111111111111_DOxxxxxx
Period	integer	否	采样周期，单位：分钟，取值可为 1、5、10。	10

返回参数

名称	类型	描述	示例值
	object
RequestId	string	公共参数，每个请求的 ID 都是唯一的，可用于排查和定位问题。	CE57AEDC-8FD2-43ED-8E3B-1F878077****
Data	object	数据集合。
Records	object
StatsDataDo	array<object>	采集点信息。
	object
Y	number	纵轴，数据（TPS 或者总量）。	0
X	integer	横轴，时间戳，单位：毫秒。	1570867800000
XUnit	string	横轴单位。统计时间：ms。	ms
YUnit	string	纵轴单位。统计的消息消费数量 msg，或者统计的消息消费 TPS msg/min。	msg
Title	string	Table 的名称。	TopicXXX@GID_XXXReceive Trend Chart

示例

正常返回示例

JSON格式

{
  "RequestId": "CE57AEDC-8FD2-43ED-8E3B-1F878077****",
  "Data": {
    "Records": {
      "StatsDataDo": [
        {
          "Y": 0,
          "X": 1570867800000
        }
      ]
    },
    "XUnit": "ms",
    "YUnit": "msg",
    "Title": "TopicXXX@GID_XXXReceive Trend Chart"
  }
}

错误码

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

变更历史

更多信息，参考变更详情。