OnsMessageGetByMsgId によるメッセージ ID でのメッセージ配送トレース - ApsaraMQ for RocketMQ

メッセージ ID を指定してメッセージの情報を照会し、メッセージが消費済みかどうかを判断します。

操作説明

説明

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

メッセージが期待どおりに消費されない場合、この操作を呼び出してメッセージの情報を照会し、トラブルシューティングを行うことができます。
この操作では、完全一致メソッドを使用してメッセージ ID に基づいてメッセージを照会します。メッセージ ID は、メッセージ送信後に返される SendResult パラメーターから取得できます。各メッセージの送信後に返された情報を保存する必要があります。照会されたメッセージの情報には、メッセージが送信された時点、メッセージが保存されているブローカー、メッセージキーやタグなどのメッセージの属性が含まれます。

今すぐお試しください

この 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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
MsgId	string	必須	照会するメッセージの ID。	1E0578FE110F18B4AAC235C05F2*****
Topic	string	必須	照会するメッセージが含まれる Topic。	test-mq_topic
InstanceId	string	任意	照会するメッセージが属するインスタンスの ID。	MQ_INST_111111111111_DOxxxxxx

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID。これは共通パラメーターです。各リクエストには一意の ID があります。この ID を使用して問題をトラブルシューティングできます。	A07E3902-B92E-44A6-B6C5-6AA111111****
Data	object	返されたデータ。
StoreSize	integer	メッセージのサイズ。	407
ReconsumeTimes	integer	コンシューマーにメッセージを送信するために実行された再試行回数。	1
StoreTimestamp	integer	ApsaraMQ for RocketMQ ブローカーがメッセージを保存した日時を示すタイムスタンプ。	1570761026708
InstanceId	string	インスタンスの ID。	MQ_INST_111111111111_DOxxxxxx
MsgId	string	メッセージの ID。	1E0578FE110F18B4AAC235C0C8460BA2
StoreHost	string	メッセージを保存する ApsaraMQ for RocketMQ ブローカー。	11.220.*.*: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 を示します。 Message Queue for Apache RocketMQ で使用される用語については、「用語」をご参照ください。	TAGS
BornTimestamp	integer	メッセージが生成された日時を示すタイムスタンプ。	1570761026630
BodyCRC	integer	メッセージ本文の巡回冗長検査 (CRC) 値。	914112295
BornHost	string	メッセージを生成したプロデューサーインスタンス。	42.120..:64646

例

成功レスポンス

JSONJSON

{
  "RequestId": "A07E3902-B92E-44A6-B6C5-6AA111111****",
  "Data": {
    "StoreSize": 407,
    "ReconsumeTimes": 1,
    "StoreTimestamp": 1570761026708,
    "InstanceId": "MQ_INST_111111111111_DOxxxxxx",
    "MsgId": "1E0578FE110F18B4AAC235C0C8460BA2",
    "StoreHost": "11.220.***.***:10911",
    "Topic": "test-mq_topic",
    "PropertyList": {
      "MessageProperty": [
        {
          "Value": "TagA",
          "Name": "TAGS"
        }
      ]
    },
    "BornTimestamp": 1570761026630,
    "BodyCRC": 914112295,
    "BornHost": "42.120.**.**:64646"
  }
}

エラーコード

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

変更履歴

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