GetTrace API でメッセージトレースをデバッグ - ApsaraMQ for RocketMQ

指定された Topic 内の指定されたメッセージのトレースを取得します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

rocketmq:GetTrace

get

*Topic

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}

なし

リクエスト構文

GET /instances/{instanceId}/topics/{topicName}/traces/{messageId} HTTP/1.1

パスパラメータ

パラメーター	型	必須 / 任意	説明	例
instanceId	string	必須	クエリ対象のインスタンスの ID。	rmq-cn-zvp2vtypu05
topicName	string	必須	クエリ対象の Topic の名前。	linkedcare-image
messageId	string	必須	メッセージ ID。	012A5AB0BBEC8A000104C6342B00001ECF

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
startTime	string	任意	開始時刻。	2023-05-10 10:42:11
endTime	string	任意	終了時刻。	2024-09-09 09:00:00

レスポンスフィールド

フィールド	型	説明	例
	object	応答。
requestId	string	リクエスト ID。各リクエストには一意の ID があります。この ID を使用して問題をトラブルシューティングできます。	7779A8FC-1BCD-5A1D-A603-C4A9BD8ADC49
success	boolean	リクエストが成功したかどうかを示します。	true
data	object	返されたデータ。
regionId	string	リージョン ID。	cn-hangzhou
instanceId	string	インスタンス ID。	rmq-cn-7e22ody****
topicName	string	Topic 名。	topic_test
messageInfo	object	メッセージ情報。
regionId	string	リージョン ID。	cn-beijing
instanceId	string	インスタンス ID。	rmq-cn-u0t2ygjq505
topicName	string	Topic 名。	Topic_normal_inspector
messageId	string	メッセージ ID。	0A79275A00207A4F0F2916C92F9A0B94
bornTime	string	メッセージが生成された時刻。	2023-03-22 12:17:08
storeTime	string	メッセージが保存された時刻。	2023-03-22 12:17:08
body	string	メッセージ本文。	{}
bornHost	string	メッセージのソース。	x.x.x.x
storeHost	string	メッセージが保存されている場所。	x.x.x.x
messageType	string	メッセージタイプ。	NORMAL
messageTag	string	タグのリスト。	xx
messageGroup	string	以前のシャーディングキー。このパラメーターは順序指定メッセージに固有です。	xx
messageKeys	array	ビジネス ID。
	string	ビジネス ID。	xx
userProperties	object	ユーザー定義のプロパティ。
	string	ユーザー定義のプロパティ。	xx
transactionId	string	トランザクション ID。	xx
liteTopicName	string	軽量 Topic の名前。	abc
producerInfo	object	プロデューサーのトレース情報。
records	array<object>	生成レコードのリスト。
	object	生成レコードのリスト。
userName	string	プロデューサー名。	xxx
clientHost	string	ホスト名。	xx.xx.xx.xx
produceTime	string	メッセージが送信された時刻。	2023-03-22 12:17:08
produceDuration	integer	メッセージの送信にかかった時間。	100
produceStatus	string	送信ステータス。	SUCCESS
arriveTime	string	到着時刻。	2023-03-22 12:17:08
messageSource	string	メッセージソース。	CONSOLE
dlqOriginTopic	string	デッドレターキューの Topic。	test_topic
dlqOriginMessageId	string	デッドレターキュー内のメッセージの ID。	0A79275A00207A4F0F2916C92F9A0B94
recallTime	string	取り消しリクエストが開始された時刻。このフィールドは、`messageSource` が `recall` の場合に空になりません。	空 \| 2023-03-22 12:17:08
brokerInfo	object	ブローカーのトレース情報。
presetDelayTime	string	プリセットされた配信時間。	2023-03-22 12:17:08
delayStatus	string	スケジュールされたメッセージのステータス。	SUCCESS
operations	array<object>	操作のリスト。
	object	操作のリスト。
operateType	string	操作タイプ。	ADD
operateTime	string	操作時間。	2023-03-22 12:17:08
recallResult	string	取り消し操作の結果。取り消しレコードが存在する場合、このフィールドは空になりません。	空 \| RECALL_OK \| RECALL_FAIL
consumerInfos	array<object>	コンシューマーのトレース情報。
	array<object>	コンシューマーのトレース情報。
consumerGroupId	string	コンシューマーグループ ID。	GID_inspector_group
records	array<object>	消費レコードのリスト。
	array<object>	消費レコードのリスト。
userName	string	コンシューマー名。	test
clientHost	string	ホスト名。	xx.xx.xx.xx
fifoEnable	boolean	メッセージが順序どおりに消費されるかどうかを示します。	true
consumeStatus	string	消費ステータス。	SUCCESS
operations	array<object>	操作のリスト。
	object	操作のリスト。
operateType	string	操作タイプ。	ADD
operateTime	string	操作時間。	2023-03-22 12:17:08
invisibleTime	integer	非表示期間 (ミリ秒単位)。	100
deadMessage	boolean	メッセージがデッドレターメッセージであるかどうかを示します。	true
popCk	string	POP チェックポイント。	123
consumeStatus	string	消費ステータス。	SUCCESS
deadMessage	boolean	メッセージがデッドレターメッセージであるかどうかを示します。	true
deadLetterInfo	object	デッドレターメッセージに関する情報。
topicName	string	Topic 名。	Register_Sync
messageId	string	メッセージ ID。	7F000001001F7A4F0F29463F0376047D
toDlqTime	string	メッセージがデッドレターキューに到着した時刻。	2023-03-22 12:17:08
code	string	エラーコード。	InvalidConsumerGroupId
message	string	エラーメッセージ。	The instance cannot be found.
httpStatusCode	integer	HTTP ステータスコード。	200
dynamicCode	string	動的エラーコード。	InstanceId
dynamicMessage	string	動的エラーメッセージ。	instanceId

例

成功レスポンス

JSONJSON

{
  "requestId": "7779A8FC-1BCD-5A1D-A603-C4A9BD8ADC49",
  "success": true,
  "data": {
    "regionId": "cn-hangzhou",
    "instanceId": "rmq-cn-7e22ody****",
    "topicName": "topic_test",
    "messageInfo": {
      "regionId": "cn-beijing",
      "instanceId": "rmq-cn-u0t2ygjq505",
      "topicName": "Topic_normal_inspector",
      "messageId": "0A79275A00207A4F0F2916C92F9A0B94",
      "bornTime": "2023-03-22 12:17:08",
      "storeTime": "2023-03-22 12:17:08",
      "body": "{}",
      "bornHost": "x.x.x.x",
      "storeHost": "x.x.x.x",
      "messageType": "NORMAL",
      "messageTag": "xx",
      "messageGroup": "xx",
      "messageKeys": [
        "xx"
      ],
      "userProperties": {
        "key": "xx"
      },
      "transactionId": "xx",
      "liteTopicName": "abc"
    },
    "producerInfo": {
      "records": [
        {
          "userName": "xxx",
          "clientHost": "xx.xx.xx.xx",
          "produceTime": "2023-03-22 12:17:08",
          "produceDuration": 100,
          "produceStatus": "SUCCESS",
          "arriveTime": "2023-03-22 12:17:08",
          "messageSource": "CONSOLE",
          "dlqOriginTopic": "test_topic",
          "dlqOriginMessageId": "0A79275A00207A4F0F2916C92F9A0B94",
          "recallTime": "空 | 2023-03-22 12:17:08"
        }
      ]
    },
    "brokerInfo": {
      "presetDelayTime": "2023-03-22 12:17:08",
      "delayStatus": "SUCCESS",
      "operations": [
        {
          "operateType": "ADD",
          "operateTime": "2023-03-22 12:17:08"
        }
      ],
      "recallResult": "空 | RECALL_OK | RECALL_FAIL"
    },
    "consumerInfos": [
      {
        "consumerGroupId": "GID_inspector_group",
        "records": [
          {
            "userName": "test",
            "clientHost": "xx.xx.xx.xx",
            "fifoEnable": true,
            "consumeStatus": "SUCCESS",
            "operations": [
              {
                "operateType": "ADD",
                "operateTime": "2023-03-22 12:17:08",
                "invisibleTime": 100,
                "deadMessage": true
              }
            ],
            "popCk": "123"
          }
        ],
        "consumeStatus": "SUCCESS",
        "deadMessage": true,
        "deadLetterInfo": {
          "topicName": "Register_Sync",
          "messageId": "7F000001001F7A4F0F29463F0376047D",
          "toDlqTime": "2023-03-22 12:17:08"
        }
      }
    ]
  },
  "code": "InvalidConsumerGroupId",
  "message": "The instance cannot be found.",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

エラーコード

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

変更履歴

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