使用ListMessagesAPI查詢訊息列表-雲訊息佇列 RocketMQ 版-阿里雲

查詢訊息列表。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

rocketmq:ListMessages

list

*Topic

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

無

請求文法

GET /instances/{instanceId}/topics/{topicName}/messages HTTP/1.1

路徑參數

名稱	類型	必填	描述	樣本值
instanceId	string	是	執行個體 ID。	rmq-cn-zvp2vtypu05
topicName	string	是	主題名稱。	test_delay_queue

請求參數

名稱	類型	必填	描述	樣本值
messageId	string	否	訊息 ID。	7F00000100207A4F0F294A938F7807AE
messageKey	string	否	訊息 key。	XSCBillResult
startTime	string	否	查詢時間範圍：開始時間。	2024-09-09 08:00:00
endTime	string	否	查詢時間範圍：結束時間	2024-09-09 09:00:00
pageNumber	integer	否	當前頁碼，從 1 開始。	1
pageSize	integer	否	分頁大小，每頁最多顯示的返回結果數量。	10
scrollId	string	否	請求滾動 ID。第一頁請求無需傳遞，後續分頁請求根據第一頁返回結果，帶上該欄位。	B13D0B07-F24B-4790-88D8-D47A38063D00
liteTopicName	string	否	輕量主題名稱	abc

返回參數

名稱	類型	描述	樣本值
	object	返回結果
requestId	string	請求 ID	A3531B6A-5A88-52BD-B3C4-A024C3D0AA2E
success	boolean	是否成功	true
data	object	返回結果
pageNumber	integer	當前頁碼	1
pageSize	integer	分頁大小	50
totalCount	integer	總記錄數	0
list	array<object>	分頁資料
	array<object>	訊息資訊
regionId	string	地區 ID	cn-hangzhou
instanceId	string	執行個體 ID	rmq-cn-7e22ody****
topicName	string	主題名稱	topic_test
messageId	string	訊息 ID	7F000001000114B4340C5ABF94500079
bornTime	string	產生時間	2023-03-22 12:17:08
storeTime	string	儲存時間	2023-03-22 12:17:08
body	string	訊息體	{}
bodySize	integer	訊息體大小。	100
bornHost	string	訊息生產用戶端	xx.xx.xx.xx
storeHost	string	訊息儲存服務端	xx.xx.xx.xx
messageType	string	訊息類型	NORMAL
messageTag	string	訊息標籤	xx
messageGroup	string	訊息分組，順序訊息專屬。	xx
messageKeys	array	業務標識
	string	業務標識。	xx
userProperties	object	使用者屬性
	string	使用者屬性。	xx
liteTopicName	string	輕量主題名稱	abc
scrollId	string	請求滾動 ID。系統自動產生，後續分頁請求需要帶上該返回結果，才能持續分頁。	B13D0B07-F24B-4790-88D8-D47A38063D00
code	string	錯誤碼	MissingInstanceId
message	string	錯誤資訊	Parameter instanceId is mandatory for this action .
httpStatusCode	integer	HTTP 狀態代碼	200
dynamicCode	string	動態錯誤碼	InstanceId
dynamicMessage	string	動態錯誤資訊	instanceId

樣本

正常返回樣本

JSON格式

{
  "requestId": "A3531B6A-5A88-52BD-B3C4-A024C3D0AA2E",
  "success": true,
  "data": {
    "pageNumber": 1,
    "pageSize": 50,
    "totalCount": 0,
    "list": [
      {
        "regionId": "cn-hangzhou",
        "instanceId": "rmq-cn-7e22ody****",
        "topicName": "topic_test",
        "messageId": "7F000001000114B4340C5ABF94500079",
        "bornTime": "2023-03-22 12:17:08",
        "storeTime": "2023-03-22 12:17:08",
        "body": "{}",
        "bodySize": 100,
        "bornHost": "xx.xx.xx.xx",
        "storeHost": "xx.xx.xx.xx",
        "messageType": "NORMAL",
        "messageTag": "xx",
        "messageGroup": "xx",
        "messageKeys": [
          "xx"
        ],
        "userProperties": {
          "key": "xx"
        },
        "liteTopicName": "abc"
      }
    ],
    "scrollId": "B13D0B07-F24B-4790-88D8-D47A38063D00"
  },
  "code": "MissingInstanceId",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

錯誤碼

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

變更歷史

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