使用OnsConsumerTimeSpan查詢Topic可重設時間範圍-雲訊息佇列 RocketMQ 版-阿里雲

介面說明

重要阿里雲提供的 OpenAPI 屬於管控類 API，用於管理和查詢阿里雲服務的相關資源。僅推薦在管控鏈路整合，訊息收發的核心資料鏈路中嚴禁依賴 OpenAPI 實現，否則可能會導致鏈路產生風險。

使用本介面可以查詢某個 Topic 在當前伺服器上儲存的最早和最晚的一條訊息的時間，以及查詢消費端最近消費的時間。本介面一般用於展示消費進度的概況，和 OnsConsumerAccumulate 介面配合使用。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

mq:QueryConsumerTimeSpan

get

Topic

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

Topic

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

無

mq:OnsInstanceBaseInfo

請求參數

名稱	類型	必填	描述	樣本值
GroupId	string	是	需查詢的消費端 Group ID。	GID_test_group_id
Topic	string	是	需查詢的消費端 Group ID 訂閱的 Topic。	test-mq_topic
InstanceId	string	否	需查詢的消費端 Group ID 所對應的執行個體 ID。	MQ_INST_111111111111_DOxxxxxx

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	公用參數，每個請求的 ID 都是唯一的，可用於排查和定位問題。	A07E3902-B92E-44A6-B6C5-6AA111111****
Data	object	查詢結果。
MaxTimeStamp	integer	整個 Topic 目前最新儲存的訊息的生產時間。	1570761026804
ConsumeTimeStamp	integer	當前 Group 消費該 Topic 的最新時間。	1570761026400
Topic	string	需查詢的 Topic。	test-mq_topic
MinTimeStamp	integer	整個 Topic 目前最早儲存的訊息的生產時間。	1570701231122
InstanceId	string	需查詢的消費端 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"
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。