使用 OnsConsumerTimeSpan 查询当前 Group ID 订阅的 Topic 的最新消息时间戳以及消费的最新时间。

使用本接口可以查询某个 Topic 当前服务器上存在的消息的最新时间和最早时间,以及查询消费端最近消费的时间。本接口一般用于展示消费进度的概况,和 OnsConsumerAccumulate 接口配合使用。

调试

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

请求参数

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

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

GroupId String GID_test_group_id

需查询的消费端 Group ID

Topic String test-mq_topic

需查询的消费端 Group ID 订阅的 Topic

InstanceId String MQ_INST_111111111111_DOxxxxxx

需查询的消费端 Group ID 所对应的实例 ID。针对有独立命名空间的实例,该参数为必填。

返回数据

名称 类型 示例值 描述
Data

查询结果

ConsumeTimeStamp Long 1570761026400

当前 Group 消费该 Topic 的最新的时间

InstanceId String MQ_INST_111111111111_DOxxxxxx

需查询的消费端 Group ID 所对应的实例 ID

MaxTimeStamp Long 1570761026804

整个 Topic 目前存储的最早的消息的时间

MinTimeStamp Long 1570701231122

整个 Topic 目前存储的最新的消息的时间

Topic String test-mq_topic

需查询的 Topic 名称

RequestId String A07E3902-B92E-44A6-B6C5-6AA1111111799

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

示例

请求示例


http(s)://[Endpoint]/?Action=OnsConsumerTimeSpan
&GroupId=GID_test_group_id
&Topic=test-mq_topic
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&<公共请求参数>

正常返回示例

XML 格式

<OnsConsumerTimeSpanResponse>
  <Data>
        <MinTimeStamp>1570701231122</MinTimeStamp>
        <ConsumeTimeStamp>1570761026400</ConsumeTimeStamp>
        <InstanceId>MQ_INST_1380156306793859_BbCOxxsU</InstanceId>
        <Topic>test-mq_topic</Topic>
        <MaxTimeStamp>1570761026804</MaxTimeStamp>
  </Data>
  <RequestId>A07E3902-B92E-44A6-B6C5-6AA1111111799</RequestId>
</OnsConsumerTimeSpanResponse>

JSON 格式

{
	"Data":{
		"MinTimeStamp":1570701231122,
		"ConsumeTimeStamp":1570761026400,
		"InstanceId":"MQ_INST_1380156306793859_BbCOxxsU",
		"Topic":"test-mq_topic",
		"MaxTimeStamp":1570761026804
	},
	"RequestId":"A07E3902-B92E-44A6-B6C5-6AA1111111799"
}

错误码

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