使用 GetConsumeTimespan 擷取消費者位移量重設範圍 - ApsaraMQ for RocketMQ

查詢topic可重設時間範圍

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

rocketmq:GetConsumeTimespan

get

*ConsumerGroup

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}/consumergroup/{#ConsumerGroupId}

無

請求文法

GET /instances/{instanceId}/consumerGroups/{consumerGroupId}/consumeTimespan/{topicName} HTTP/1.1

路徑參數

名稱	類型	必填	描述	樣本值
instanceId	string	是	執行個體的 ID。	rmq-cn-7e22ody****
consumerGroupId	string	是	消費者分組 ID。	CID-TEST
topicName	string	是	消費者分組訂閱的主題名稱。	topicxxx

請求參數

名稱

類型

必填

描述

樣本值

當前API無需請求參數

返回參數

名稱	類型	描述	樣本值
	object	Result
requestId	string	請求 ID，每個請求的 ID 都是唯一的，可用於排查和定位問題。	C115601B-8736-5BBF-AC99-7FEAE1245A80
success	boolean	執行結果是否成功。	true
data	object	返回結果
instanceId	string	執行個體 ID	rmq-cn-7e22ody****
topicName	string	指定消費者分組訂閱的主題。	topic_test
consumerGroupId	string	消費者分組的 ID。	CID-TEST
minTimestamp	integer	整個 Topic 目前最早儲存的訊息的生產時間。	1570761026222
maxTimestamp	integer	整個 Topic 目前最新儲存的訊息的生產時間。	1570761026833
consumeTimestamp	integer	當前 Group 消費該 Topic 的最新時間。	1570761026400
code	string	錯誤碼。	MissingInstanceId
message	string	錯誤資訊	Parameter instanceId is mandatory for this action .
httpStatusCode	integer	HTTP 狀態代碼	200
dynamicCode	string	動態錯誤碼。	xxx
dynamicMessage	string	動態錯誤資訊	xxx

樣本

正常返回樣本

JSON格式

{
  "requestId": "C115601B-8736-5BBF-AC99-7FEAE1245A80",
  "success": true,
  "data": {
    "instanceId": "rmq-cn-7e22ody****",
    "topicName": "topic_test",
    "consumerGroupId": "CID-TEST",
    "minTimestamp": 1570761026222,
    "maxTimestamp": 1570761026833,
    "consumeTimestamp": 1570761026400
  },
  "code": "MissingInstanceId",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 200,
  "dynamicCode": "xxx",
  "dynamicMessage": "xxx"
}

錯誤碼

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

變更歷史

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