OnsDLQMessageGetById を使用してメッセージ ID でデッドレターメッセージをクエリ - ApsaraMQ for RocketMQ

メッセージ ID に基づいて特定のデッドレターメッセージをクエリします。返される情報には、ストレージ時間、メッセージ本文、キー、タグが含まれます。

操作説明

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

メッセージ ID によるデッドレターメッセージのクエリは term クエリです。メッセージ ID は、送信操作が成功した際の SendResult またはバッチクエリ API 呼び出しから取得できます。このクエリは、ストレージ時間、メッセージ本文、キー、タグなど、デッドレターメッセージの属性を返します。

今すぐお試しください

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

get

Group

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

Group

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

なし

mq:OnsInstanceBaseInfo

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
MsgId	string	必須	クエリ対象のメッセージの ID。これはメッセージ ID です。	0BC16699165C03B925DB8A404E2D****
GroupId	string	必須	コンシューマーのグループ ID。	GID_test_group_id
InstanceId	string	任意	メッセージが属するインスタンスの ID。	MQ_INST_111111111111_DOxxxxxx

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。これは共通パラメーターです。各リクエストには一意の ID があります。	A07E3902-B92E-44A6-B6C5-6AA111111****
Data	object	クエリ結果。
StoreSize	integer	メッセージサイズ。単位：KB。	407
ReconsumeTimes	integer	メッセージが再試行された回数。	1
StoreTimestamp	integer	メッセージがサーバー側に保存されたときのタイムスタンプ。単位：ミリ秒。	1570761026708
InstanceId	string	インスタンス ID。	MQ_INST_111111111111_DOxxxxxx
MsgId	string	メッセージ ID。	0BC16699165C03B925DB8A404E2D****
StoreHost	string	メッセージを保存するサーバーインスタンス。	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。詳細については、「用語」をご参照ください。	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": "0BC16699165C03B925DB8A404E2D****",
    "StoreHost": "11.220.***.***:10911",
    "Topic": "test-mq_topic",
    "PropertyList": {
      "MessageProperty": [
        {
          "Value": "TagA",
          "Name": "TAGS"
        }
      ]
    },
    "BornTimestamp": 1570761026630,
    "BodyCRC": 914112295,
    "BornHost": "42.120.**.**:64646"
  }
}

エラーコード

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

変更履歴

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