使用OnsMessageGetByKey根據Message Key查詢訊息-雲訊息佇列 RocketMQ 版-阿里雲

根據 Topic 和 Message Key 模糊查詢訊息資訊列表。

介面說明

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

使用本介面根據 Message Key 查詢訊息的方式屬於模糊查詢。由於業務方的 Key 可能不唯一，所以查詢結果可能為多條。
本介面用在業務方無法擷取 Message ID 的情境，在該情境下的調用步驟如下所示：
1. 調用本介面模糊查詢得到 Message ID 列表。
2. 調用 OnsMessageGetByMsgId 介面精確查詢。OnsMessageGetByMsgId 介面的詳細資料，請參見 OnsMessageGetByMsgId 。

調試

您可以在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

請求參數

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

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
RequestId	string	公用參數，每個請求的 ID 都是唯一的，可用於排查和定位問題。	A07E3902-B92E-44A6-B6C5-6AA111111****
Data	object
OnsRestMessageDo	array<object>	查詢結果清單。
	array<object>
StoreSize	integer	訊息大小。	406
ReconsumeTimes	integer	訊息重試消費的次數。	1
StoreTimestamp	integer	被 Broker 儲存的時間戳記。	1570760999811
InstanceId	string	執行個體 ID。	MQ_INST_111111111111_DOxxxxxx
MsgId	string	訊息 ID，即 Message ID。	1E0578FE110F18B4AAC235C05F2*****
StoreHost	string	儲存該訊息的伺服器執行個體。	11.193.*.*: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	產生時間戳記。	1570760999721
BodyCRC	integer	訊息體 CRC 校正值。	914112295
BornHost	string	產生該訊息的用戶端執行個體。	42.120.*.*:59270

樣本

正常返回樣本

JSON格式

{
  "RequestId": "A07E3902-B92E-44A6-B6C5-6AA111111****",
  "Data": {
    "OnsRestMessageDo": [
      {
        "StoreSize": 406,
        "ReconsumeTimes": 1,
        "StoreTimestamp": 1570760999811,
        "InstanceId": "MQ_INST_111111111111_DOxxxxxx",
        "MsgId": "1E0578FE110F18B4AAC235C05F2*****",
        "StoreHost": "11.193.***.***:10911",
        "Topic": "test-mq_topic",
        "PropertyList": {
          "MessageProperty": [
            {
              "Value": "TagA",
              "Name": "TAGS"
            }
          ]
        },
        "BornTimestamp": 1570760999721,
        "BodyCRC": 914112295,
        "BornHost": "42.120.***.***:59270"
      }
    ]
  }
}

錯誤碼

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

變更歷史

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