查询指定的 Group ID 订阅的 Topic 的最新消息时间戳以及消费的最新时间。可以查询某个 Topic 当前服务器上存在的消息的最新时间和最早时间,以及查询消费端最近消费的时间。本接口一般用于展示消费进度的概况,与 QueryMqSofamqConsumerAccumulate 接口配合使用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | QueryMqSofamqConsumerTimespan | 系统规定参数。取值:QueryMqSofamqConsumerTimespan。 |
Cell | String | 是 | RZ01A | 需查询的消费端 Group ID 所在的 Cell |
GroupId | String | 是 | GID_test_group_id | 需查询的消费端 Group ID |
InstanceId | String | 是 | MQ_INST_111111111111_DOxxxxxx | 需查询的消费端 Group ID 所对应的实例 ID。针对有独立命名空间的实例,该参数为必填。 |
Topic | String | 是 | test-mq_topic | 需查询的消费端 Group ID 订阅的 Topic |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Data | Struct | 查询结果 |
|
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 | 861E6630-AEC0-4B2D-B214-6CB5E44B7F04 | 请求ID |
ResultCode | String | OK | 结果码 |
ResultMessage | String | OK | 结果描述 |
示例
请求示例
http(s)://[Endpoint]/?Action=QueryMqSofamqConsumerTimespan
&Cell=RZ01A
&GroupId=GID_test_group_id
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&Topic=test-mq_topic
&<公共请求参数>
正常返回示例
XML
格式
<RequestId>861E6630-AEC0-4B2D-B214-6CB5E44B7F04</RequestId>
<Data>
<MinTimestamp>1570701231122</MinTimestamp>
<ConsumeTimestamp>1570761026400</ConsumeTimestamp>
<InstanceId>MQ_INST_111111111111_DOxxxxxx</InstanceId>
<MaxTimestamp>1570761026804</MaxTimestamp>
<Topic>test-mq_topic</Topic>
</Data>
<ResultMessage>OK</ResultMessage>
<ResultCode>OK</ResultCode>
JSON
格式
{"RequestId":"861E6630-AEC0-4B2D-B214-6CB5E44B7F04","Data":{"MinTimestamp":"1570701231122","ConsumeTimestamp":"1570761026400","InstanceId":"MQ_INST_111111111111_DOxxxxxx","MaxTimestamp":"1570761026804","Topic":"test-mq_topic"},"ResultMessage":"OK","ResultCode":"OK"}
错误码
访问错误中心查看更多错误码。