すべてのプロダクト
Search

このプロダクト

    ApsaraMQ for RocketMQ:GetTrace

    ドキュメントセンター

    ApsaraMQ for RocketMQ:GetTrace

    最終更新日:Sep 24, 2026

    指定された 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

    任意

    開始時刻。YYYY-MM-DD HH:mm:ss フォーマット。

    2023-05-10 10:42:11
    endTime

    string

    任意

    終了時刻。YYYY-MM-DD HH:mm:ss フォーマット。

    2024-09-09 09:00:00

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    結果。

    requestId

    string

    リクエストの 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

    メッセージが生成された時間。YYYY-MM-DD HH:mm:ss フォーマット。

    2023-03-22 12:17:08
    storeTime

    string

    メッセージがログブローカーに保存された時間。YYYY-MM-DD HH:mm:ss フォーマット。

    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

    メッセージキー。

    string

    メッセージキー。

    xx
    userProperties

    object

    ユーザープロパティ。

    string

    ユーザープロパティ。

    xx
    transactionId

    string

    トランザクションの ID。

    xx
    liteTopicName

    string

    Lite Topic 名。

    abc
    producerInfo

    object

    プロデューサーのメッセージトレース情報のフォーマット。

    records

    array<object>

    プロデューサーの Record のリスト。

    object

    プロデューサーの Record のリスト。

    userName

    string

    プロデューサー名。

    xxx
    clientHost

    string

    ホスト名。

    xx.xx.xx.xx
    produceTime

    string

    メッセージが送信された時間。YYYY-MM-DD HH:mm:ss フォーマット。

    2023-03-22 12:17:08
    produceDuration

    integer

    メッセージの送信にかかった時間。

    100
    produceStatus

    string

    送信ステータス。

    SUCCESS
    arriveTime

    string

    メッセージが到着した時間。YYYY-MM-DD HH:mm:ss フォーマット。

    2023-03-22 12:17:08
    messageSource

    string

    メッセージのソース。

    CONSOLE
    dlqOriginTopic

    string

    デッドレターキューの Topic。

    test_topic
    dlqOriginMessageId

    string

    デッドレターキューのメッセージの ID。

    0A79275A00207A4F0F2916C92F9A0B94
    recallTime

    string

    再現率リクエストが開始された時間。このフィールドは、メッセージソースが "recall" の場合に空ではありません。

    2023-03-22 12:17:08
    brokerInfo

    object

    ブローカーのメッセージトレース情報のフォーマット。

    presetDelayTime

    string

    事前設定された配信時間。YYYY-MM-DD HH:mm:ss フォーマット。

    2023-03-22 12:17:08
    delayStatus

    string

    スケジュールされたメッセージステータス。

    SUCCESS
    operations

    array<object>

    操作のリスト。

    object

    操作のリスト。

    operateType

    string

    操作タイプ。

    ADD
    operateTime

    string

    操作の時間。YYYY-MM-DD HH:mm:ss フォーマット。

    2023-03-22 12:17:08
    recallResult

    string

    再現率の結果。このフィールドは、再現率の Record が存在する場合に空ではありません。

    RECALL_OK | RECALL_FAIL
    consumerInfos

    array<object>

    コンシューマーのメッセージトレース情報のフォーマット。

    array<object>

    コンシューマーのメッセージトレース情報のフォーマット。

    consumerGroupId

    string

    コンシューマーグループの ID。

    GID_inspector_グループ
    records

    array<object>

    消費 Record のリスト。

    array<object>

    消費 Record のリスト。

    userName

    string

    コンシューマー名。

    test
    clientHost

    string

    ホスト名。

    xx.xx.xx.xx
    fifoEnable

    boolean

    順序消費が有効かどうかを示します。

    true
    consumeStatus

    string

    消費ステータス。

    SUCCESS
    operations

    array<object>

    操作のリスト。

    object

    操作のリスト。

    operateType

    string

    操作タイプ。

    ADD
    operateTime

    string

    操作の時間。YYYY-MM-DD HH:mm:ss フォーマット。

    2023-03-22 12:17:08
    invisibleTime

    integer

    非表示の時間。ミリ秒単位。

    100
    deadMessage

    boolean

    メッセージがデッドレターメッセージかどうかを示します。

    true
    popCk

    string

    POP_CK。

    123
    consumeStatus

    string

    消費ステータス。

    SUCCESS
    deadMessage

    boolean

    メッセージがデッドレターメッセージかどうかを示します。

    true
    deadLetterInfo

    object

    デッドレターメッセージ情報のフォーマット。

    topicName

    string

    Topic 名。

    Register_Sync
    messageId

    string

    メッセージの ID。

    7F000001001F7A4F0F29463F0376047D
    toDlqTime

    string

    メッセージがデッドレターキューに到着した時間。YYYY-MM-DD HH:mm:ss フォーマット。

    2023-03-22 12:17:08
    code

    string

    エラーコード。

    InvalidConsumerGroupId
    message

    string

    エラーメッセージ。

    インスタンスが見つかりません
    httpStatusCode

    integer

    HTTP 状態コード。

    200
    dynamicCode

    string

    動的なエラーコード。

    InstanceId
    dynamicMessage

    string

    動的なエラーメッセージ。

    インスタンスID

    例

    成功レスポンス

    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": "Empty | 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": "Empty | 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"
}

    エラーコード

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

    変更履歴

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