調用OnsMessageGetByMsgId介面通過MsgId查詢訊息-雲訊息佇列 RocketMQ 版-阿里雲

通過傳入 Message ID 查詢指定訊息的資訊以及判斷該指定的訊息是否曾被消費過。

介面說明

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

如遇訊息消費有問題，則可通過該介面查詢具體發送的訊息內容來排查問題。
根據 Message ID 查詢訊息的方式屬於精確查詢，查詢條件需要的 Message ID 從每次訊息發送成功的 SendResult 中擷取，因此業務方必須儲存每次發送訊息的結果。查詢到的資訊包括髮送時間、儲存伺服器和訊息的 Key 和 Tag 等屬性。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

mq:QueryMessage

get

Topic

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

Topic

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

無

mq:OnsInstanceBaseInfo

請求參數

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

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	公用參數，每個請求的 ID 都是唯一的，可用於排查和定位問題。	A07E3902-B92E-44A6-B6C5-6AA111111****
Data	object	查詢結果。
StoreSize	integer	訊息大小。	407
ReconsumeTimes	integer	訊息重試消費的次數。	1
StoreTimestamp	integer	被服務端儲存的時間戳記。	1570761026708
InstanceId	string	執行個體 ID。	MQ_INST_111111111111_DOxxxxxx
MsgId	string	訊息 ID，即 Message ID。	1E0578FE110F18B4AAC235C0C8460BA2
StoreHost	string	儲存該訊息的伺服器執行個體。	11.220.*.*:10911
Topic	string	訊息的 Topic。	test-mq_topic
PropertyList	object
MessageProperty	array<object>	訊息屬性列表。
	object
Value	string	訊息屬性的值。	TagA
Name	string	訊息屬性。取值說明如下： TRACE_ON：是否有訊息軌跡 KEYS：訊息的 Key 屬性 TAGS：訊息的 Tag 屬性 INSTANCE_ID：訊息所在的執行個體的 ID 更多概念資訊，請參見名詞解釋。	TAGS
BornTimestamp	integer	產生時間戳記。	1570761026630
BodyCRC	integer	訊息體 CRC 校正值。	914112295
BornHost	string	產生該訊息的用戶端執行個體。	42.120..:64646

樣本

正常返回樣本

JSON格式

{
  "RequestId": "A07E3902-B92E-44A6-B6C5-6AA111111****",
  "Data": {
    "StoreSize": 407,
    "ReconsumeTimes": 1,
    "StoreTimestamp": 1570761026708,
    "InstanceId": "MQ_INST_111111111111_DOxxxxxx",
    "MsgId": "1E0578FE110F18B4AAC235C0C8460BA2",
    "StoreHost": "11.220.***.***:10911",
    "Topic": "test-mq_topic",
    "PropertyList": {
      "MessageProperty": [
        {
          "Value": "TagA",
          "Name": "TAGS"
        }
      ]
    },
    "BornTimestamp": 1570761026630,
    "BodyCRC": 914112295,
    "BornHost": "42.120.**.**:64646"
  }
}

錯誤碼

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

變更歷史

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