使用OnsMessageTrace查詢訊息消費狀態-雲訊息佇列 RocketMQ 版-阿里雲

介面說明

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

本介面一般在消費異常，需要判斷訊息消費狀態，初步排查原因時使用。
本介面的實現雲端式訊息佇列 RocketMQ 版的內部位點機制，在大部分情境下判斷結果可信，但如果應用方進行過重設位點已經清除訊息等操作，則判斷結果可能有誤。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

mq:QueryMessageTrace

get

Topic

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

Topic

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

無

mq:OnsInstanceBaseInfo

請求參數

名稱	類型	必填	描述	樣本值
Topic	string	是	訊息的 Topic。	test-mq_topic
MsgId	string	是	需查詢訊息軌跡的訊息 ID，即 Message ID。	1E05791C117818B4AAC23B1BB0CE****
InstanceId	string	否	需查詢的訊息所對應的執行個體 ID。	MQ_INST_111111111111_DOxxxxxx

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	公用參數，每個請求的 ID 都是唯一的，可用於排查和定位問題。	EAE5BE23-37A1-4354-94D6-E44AE17E****
Data	object
MessageTrack	array<object>	查詢結果。
	object
TrackType	string	目前狀態。取值說明如下： CONSUMED：已消費。 CONSUMED_BUT_FILTERED：不符合 Group ID 的訂閱條件，訊息已被過濾，未消費。 NOT_CONSUME_YET：暫未消費。 NOT_ONLINE：用戶端不線上。 UNKNOWN：其他問題。	CONSUMED
ConsumerGroup	string	訂閱該 Topic 的消費者所對應的 Group ID。	GID_test_group_id
InstanceId	string	需查詢的訊息所對應的執行個體 ID。	MQ_INST_111111111111_DOxxxxxx

樣本

正常返回樣本

JSON格式

{
  "RequestId": "EAE5BE23-37A1-4354-94D6-E44AE17E****",
  "Data": {
    "MessageTrack": [
      {
        "TrackType": "CONSUMED",
        "ConsumerGroup": "GID_test_group_id",
        "InstanceId": "MQ_INST_111111111111_DOxxxxxx"
      }
    ]
  }
}

錯誤碼

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

變更歷史

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