查詢消息列表。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語(yǔ)句的Action元素中使用，用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別：是指每個(gè)操作的訪問(wèn)級(jí)別，取值為寫入（Write）、讀?。≧ead）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說(shuō)明如下：
- 對(duì)于必選的資源類型，用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問(wèn)級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| rocketmq:ListMessages | list | *Topic acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName} |
| 無(wú) |
請(qǐng)求語(yǔ)法
GET /instances/{instanceId}/topics/{topicName}/messages HTTP/1.1
請(qǐng)求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| instanceId | string | 是 | 實(shí)例 ID。 | rmq-cn-zvp2vtypu05 |
| topicName | string | 是 | 主題名稱。 | test_delay_queue |
| messageId | string | 否 | 消息 ID。 | 7F00000100207A4F0F294A938F7807AE |
| messageKey | string | 否 | 消息 key。 | XSCBillResult |
| startTime | string | 否 | 查詢時(shí)間范圍：開(kāi)始時(shí)間。 | 2024-09-09 08:00:00 |
| endTime | string | 否 | 查詢時(shí)間范圍：結(jié)束時(shí)間 | 2024-09-09 09:00:00 |
| pageNumber | integer | 否 | 當(dāng)前頁(yè)碼，從 1 開(kāi)始。 | 1 |
| pageSize | integer | 否 | 分頁(yè)大小，每頁(yè)最多顯示的返回結(jié)果數(shù)量。 | 10 |
| scrollId | string | 否 | 請(qǐng)求滾動(dòng) ID。 第一頁(yè)請(qǐng)求無(wú)需傳遞，后續(xù)分頁(yè)請(qǐng)求根據(jù)第一頁(yè)返回結(jié)果，帶上該字段。 | B13D0B07-F24B-4790-88D8-D47A38063D00 |
返回參數(shù)
示例
正常返回示例
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"
}
}
],
"scrollId": "B13D0B07-F24B-4790-88D8-D47A38063D00"
},
"code": "MissingInstanceId",
"message": "Parameter instanceId is mandatory for this action .",
"httpStatusCode": 200,
"dynamicCode": "InstanceId",
"dynamicMessage": "instanceId"
}錯(cuò)誤碼
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。