调用OnsConsumerTimeSpan查询当前Group ID订阅的Topic可重置的时间范围,即该Topic中储存的最早的和最晚的一条消息的生产时间。
使用说明
使用本接口可以查询某个Topic在当前服务器上存储的最早和最晚的一条消息的时间,以及查询消费端最近消费的时间。本接口一般用于展示消费进度的概况,和OnsConsumerAccumulate接口配合使用。
QPS限制
本接口的单用户QPS限制为10次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
授权信息
默认仅限阿里云账号使用本接口,RAM用户只有在被授予了相关API操作权限后方可使用。本接口的授权信息如下表所示。更多信息,请参见权限策略和示例。
API |
Action |
Resource(有命名空间) |
Resource(无命名空间) |
---|---|---|---|
OnsConsumerTimeSpan |
mq:QueryInstanceBaseInfo mq:QueryConsumerTimeSpan |
acs:mq:*:*:{instanceId}%{topic} |
acs:mq:*:*:{topic} |
调试
您可以在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。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | A07E3902-B92E-44A6-B6C5-6AA111111**** |
公共参数,每个请求的ID都是唯一的,可用于排查和定位问题。 |
Data | Object |
查询结果。 |
|
MaxTimeStamp | Long | 1570761026804 |
整个Topic目前最早存储的消息的生产时间。 |
ConsumeTimeStamp | Long | 1570761026400 |
当前Group消费该Topic的最新时间。 |
Topic | String | test-mq_topic |
需查询的Topic。 |
MinTimeStamp | Long | 1570701231122 |
整个Topic目前最新存储的消息的生产时间。 |
InstanceId | String | MQ_INST_111111111111_DOxxxxxx |
需查询的消费端Group ID所对应的实例ID。 |
示例
请求示例
http(s)://ons.cn-hangzhou.aliyuncs.com/?Action=OnsConsumerTimeSpan
&GroupId=GID_test_group_id
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&Topic=test-mq_topic
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<OnsConsumerTimeSpanResponse>
<Data>
<MinTimeStamp>1570701231122</MinTimeStamp>
<ConsumeTimeStamp>1570761026400</ConsumeTimeStamp>
<InstanceId>MQ_INST_111111111111_DOxxxxxx</InstanceId>
<Topic>test-mq_topic</Topic>
<MaxTimeStamp>1570761026804</MaxTimeStamp>
</Data>
<RequestId>A07E3902-B92E-44A6-B6C5-6AA111111****</RequestId>
</OnsConsumerTimeSpanResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Data" : {
"MinTimeStamp" : 1570701231122,
"ConsumeTimeStamp" : 1570761026400,
"InstanceId" : "MQ_INST_111111111111_DOxxxxxx",
"Topic" : "test-mq_topic",
"MaxTimeStamp" : 1570761026804
},
"RequestId" : "A07E3902-B92E-44A6-B6C5-6AA111111****"
}
错误码
访问错误中心查看更多错误码。