文档

OnsConsumerTimeSpan - 查询Topic可重置时间范围

更新时间:

查询Topic可重置的时间范围,即该Topic中储存的最早的和最晚的消息的生产时间。

接口说明

注意 阿里云提供的 OpenAPI 属于管控类 API,用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成,消息收发的核心数据链路中严禁依赖 OpenAPI 实现,否则可能会导致链路产生风险。
使用本接口可以查询某个 Topic 在当前服务器上存储的最早和最晚的一条消息的时间,以及查询消费端最近消费的时间。本接口一般用于展示消费进度的概况,和 OnsConsumerAccumulate 接口配合使用。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mq:QueryConsumerTimeSpanRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
GroupIdstring

需查询的消费端 Group ID。

GID_test_group_id
Topicstring

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

test-mq_topic
InstanceIdstring

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

MQ_INST_111111111111_DOxxxxxx

返回参数

名称类型描述示例值
object
RequestIdstring

公共参数,每个请求的 ID 都是唯一的,可用于排查和定位问题。

A07E3902-B92E-44A6-B6C5-6AA111111****
Dataobject

查询结果。

MaxTimeStamplong

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

1570761026804
ConsumeTimeStamplong

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

1570761026400
Topicstring

需查询的 Topic。

test-mq_topic
MinTimeStamplong

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

1570701231122
InstanceIdstring

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

MQ_INST_111111111111_DOxxxxxx

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史