メッセージのリストをクエリします。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
rocketmq:ListMessages |
list |
*Topic
|
なし | なし |
リクエスト構文
GET /instances/{instanceId}/topics/{topicName}/messages HTTP/1.1パスパラメータ
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| instanceId |
string |
必須 |
インスタンス ID。 |
rmq-cn-zvp2vtypu05 |
| topicName |
string |
必須 |
Topic の名前。 |
test_delay_queue |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| messageId |
string |
任意 |
メッセージ ID。 |
7F00000100207A4F0F294A938F7807AE |
| messageKey |
string |
任意 |
メッセージキー。 |
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。 最初のリクエストではこのパラメーターを指定しないでください。 後続のページ分割されたクエリでは、このパラメーターを前の応答で返されたスクロール ID に設定します。 |
B13D0B07-F24B-4790-88D8-D47A38063D00 |
| liteTopicName |
string |
任意 |
軽量 Topic の名前。 |
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 の名前。 |
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 |
軽量 Topic の名前。 |
abc |
| scrollId |
string |
スクロール ID。 システムはこの ID を自動的に生成します。 結果の次のページを取得するには、後続のリクエストにこの 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 |
例
成功レスポンス
JSONJSON
{
"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"
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。