OnsMessageGetByKey を使用したキーとトピックによるメッセージのクエリ - ApsaraMQ for RocketMQ

Topic とメッセージキーに基づいて、メッセージのリストをあいまい検索します。

操作説明

重要 Alibaba Cloud が提供する OpenAPI は管理 API です。Alibaba Cloud サービスの管理およびリソースのクエリに使用できます。この API は管理データリンクにのみ統合することを推奨します。メッセージの送受信を行うコアデータリンクにはこの API を使用しないでください。データリンクにセキュリティ脅威をもたらす可能性があります。

この操作は、メッセージキーに基づいてメッセージのあいまい検索を実行します。メッセージキーは必ずしも一意ではないため、クエリによって複数のメッセージが返される場合があります。
メッセージ ID を取得できない場合は、この操作を使用できます。このシナリオでは、次の手順に従います：
1. この操作を呼び出してあいまい検索を実行し、メッセージ ID のリストを取得します。
2. OnsMessageGetByMsgId 操作を呼び出して完全一致検索を実行します。OnsMessageGetByMsgId 操作の詳細については、「OnsMessageGetByMsgId」をご参照ください。

今すぐお試しください

この 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
Key	string	必須	照会するメッセージのメッセージキー。	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	メッセージがブローカーによって保存された日時を示すタイムスタンプ。	1570760999811
InstanceId	string	インスタンス ID。	MQ_INST_111111111111_DOxxxxxx
MsgId	string	メッセージ 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：メッセージのキー。 TAGS：メッセージのタグ。 INSTANCE_ID：メッセージが属するインスタンスの ID。概念の詳細については、「用語」をご参照ください。	TAGS
BornTimestamp	integer	メッセージが作成された日時を示すタイムスタンプ。	1570760999721
BodyCRC	integer	メッセージ本文の CRC チェックサム。	914112295
BornHost	string	メッセージを作成したクライアントインスタンス。	42.120.*.*:59270

例

成功レスポンス

JSONJSON

{
  "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"
      }
    ]
  }
}

エラーコード

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

変更履歴

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