OnsMessagePageQueryByTopic を使用したトピック内のページ単位でのメッセージクエリ - ApsaraMQ for RocketMQ

指定された Topic に、指定された時間範囲内で保存されているすべてのメッセージをページ単位でクエリします。

操作説明

説明

Alibaba Cloud が提供する API 操作は、Alibaba Cloud サービスのリソースを管理およびクエリするために使用されます。これらの API 操作は、管理システムにのみ統合することを推奨します。メッセージングサービスのコアシステムでは、これらの API 操作を使用しないでください。使用した場合、システムリスクが発生する可能性があります。

クエリしたいメッセージの ID またはキーが不明な場合、この操作を呼び出して、指定された時間範囲内に Topic に保存されているすべてのメッセージをクエリできます。結果はページ単位で表示されます。
メッセージをクエリする際は、短い時間範囲を指定することを推奨します。長い時間範囲を指定すると、大量のメッセージが返されます。この場合、クエリしたいメッセージを効率的に見つけることができません。次の手順でメッセージをクエリできます。
1. Topic、開始時刻、終了時刻、および各ページで返すエントリ数を指定して、ページングクエリを実行します。Topic にメッセージが含まれている場合、デフォルトで最初のページのメッセージ情報、総ページ数、およびタスク ID が返されます。
2. タスク ID とページ番号を指定してこの操作を再度呼び出し、指定されたページのメッセージをクエリします。`BeginTime`、`EndTime`、`PageSize` パラメーターは有効になりません。デフォルトでは、指定されたクエリタスクを作成したときのリクエストで指定したこれらのパラメーターの値が使用されます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

mq:QueryMessage

get

Topic

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

Topic

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

なし

mq:OnsInstanceBaseInfo

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Topic	string	必須	クエリするメッセージが属する Topic の名前。	test-mq_topic
BeginTime	integer	必須	クエリする時間範囲の開始時刻。このパラメーターの値は、ミリ秒単位の UNIX タイムスタンプです。リクエストで TaskId パラメーターに有効な値を指定した場合、このパラメーターは有効になりません。システムは、指定されたクエリタスクを作成したときのリクエストで指定した BeginTime パラメーターの値を使用します。	1570723200000
EndTime	integer	必須	クエリする時間範囲の終了時刻。このパラメーターの値は、ミリ秒単位の UNIX タイムスタンプです。リクエストで TaskId パラメーターに有効な値を指定した場合、このパラメーターは有効になりません。システムは、指定されたクエリタスクを作成したときのリクエストで指定した EndTime パラメーターの値を使用します。	1570809600000
TaskId	string	任意	クエリタスクの ID。指定された時間範囲内に指定された Topic のメッセージ情報をクエリするためにこの操作を初めて呼び出す場合、このパラメーターは不要です。このパラメーターは、指定されたページのメッセージを後続でクエリする場合に必要です。タスク ID は、最初のクエリの戻り結果から取得できます。	0BC1310300002A9F000021E4D7A48346
CurrentPage	integer	必須	返すページ番号。ページは 1 から始まります。有効な値：1～50。	2
PageSize	integer	任意	各ページで返すエントリ数。有効な値：5～50。デフォルト値：20。リクエストで TaskId パラメーターに有効な値を指定した場合、このパラメーターは有効になりません。システムは、クエリタスクを作成するためのリクエストで指定した PageSize パラメーターの値を使用します。	5
InstanceId	string	任意	クエリするメッセージが属するインスタンスの ID。	MQ_INST_111111111111_DOxxxxxx

レスポンスフィールド

フィールド	型	説明	例
	object	返されたデータ。
RequestId	string	リクエスト ID。これは共通パラメーターです。各リクエストには一意の ID があります。この ID を使用して、問題のトラブルシューティングを行うことができます。	5DC2A47E-2B31-4722-96C8-FA59C9*****
MsgFoundDo	object	クエリされたメッセージに関する情報。
CurrentPage	integer	返されたページのページ番号。	1
MsgFoundList	object
OnsRestMessageDo	array<object>	返されたページのメッセージに関する情報。このパラメーターに含まれる情報は、OnsMessageGetByMsgId 操作によって返される情報と同じです。
	array<object>
StoreSize	integer	メッセージのサイズ。単位：KB。	406
ReconsumeTimes	integer	メッセージをコンシューマーに送信するために実行されたリトライ回数。	1
StoreTimestamp	integer	ApsaraMQ for RocketMQ ブローカーがメッセージを保存した時刻。値は、エポックタイム (1970 年 1 月 1 日 00:00:00 UTC) から経過したミリ秒数を表す UNIX タイムスタンプです。	1570760999811
InstanceId	string	インスタンスの ID	MQ_INST_111111111111_DOxxxxxx
MsgId	string	メッセージの ID。	1E0578FE110F18B4AAC235C05F2*****
StoreHost	string	メッセージを保存する ApsaraMQ for RocketMQ ブローカー。	11.193.*.*:10911
Topic	string	メッセージが属する Topic。	test-mq_topic
PropertyList	object
MessageProperty	array<object>	メッセージの属性。
	object
Value	string	属性の値。	TagA
Name	string	属性の名前。有効な値： TRACE_ON：メッセージのトレースが存在するかどうかを示します。 KEYS：メッセージのキーを示します。 TAGS：メッセージのタグを示します。 INSTANCE_ID：メッセージを含むインスタンスの ID を示します。 ApsaraMQ for RocketMQ で使用される用語については、「用語」をご参照ください。	TAGS
BornTimestamp	integer	メッセージが生成された時刻。値は、エポックタイム (1970 年 1 月 1 日 00:00:00 UTC) から経過したミリ秒数を表す UNIX タイムスタンプです。	1570760999721
BodyCRC	integer	メッセージ本文の巡回冗長検査 (CRC) 値。	914112295
BornHost	string	メッセージを生成したプロデューサーのクライアント。	42.120.*.*:59270
MaxPageCount	integer	返されたページの総数。	400
TaskId	string	クエリタスクの ID。指定された時間範囲内に指定されたコンシューマーグループに送信されたメッセージをクエリするためにこの操作を初めて呼び出すと、このパラメーターが返されます。タスク ID を使用して、他の返されたページのメッセージの詳細をクエリできます。	0BC1310300002A9F000021E4D7A48346

例

成功レスポンス

JSONJSON

{
  "RequestId": "5DC2A47E-2B31-4722-96C8-FA59C9*****",
  "MsgFoundDo": {
    "CurrentPage": 1,
    "MsgFoundList": {
      "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"
        }
      ]
    },
    "MaxPageCount": 400,
    "TaskId": "0BC1310300002A9F000021E4D7A48346"
  }
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。