すべてのプロダクト
Search

このプロダクト

    ApsaraMQ for RocketMQ:OnsMessageTrace

    ドキュメントセンター

    ApsaraMQ for RocketMQ:OnsMessageTrace

    最終更新日:Dec 12, 2025

    OnsMessageTrace 操作を呼び出して、メッセージ ID に基づいてメッセージが消費されたかどうかを判断できます。

    操作説明

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

    • この操作を使用して、消費例外が発生したときにメッセージの消費ステータスを確認し、初期のトラブルシューティングを行うことができます。

    • この操作は、ApsaraMQ for RocketMQ の内部オフセットメカニズムに基づいています。 ほとんどのシナリオで結果は信頼できます。 ただし、オフセットをリセットしたり、メッセージをパージしたりすると、結果が不正確になる場合があります。

    今すぐお試しください

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

    get

    Topic

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

    Topic

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

    		 なし
    • mq:OnsInstanceBaseInfo

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Topic

    string

    必須

    メッセージの Topic。

    test-mq_topic
    MsgId

    string

    必須

    トレースをクエリするメッセージの ID。 これはメッセージ ID です。

    1E05791C117818B4AAC23B1BB0CE****
    InstanceId

    string

    任意

    メッセージが属するインスタンスの ID。

    MQ_INST_111111111111_DOxxxxxx

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。 これは共通パラメーターです。 各リクエストには一意の ID があります。 この ID を使用して、問題のトラブルシューティングを行います。

    EAE5BE23-37A1-4354-94D6-E44AE17E****
    Data

    object

    MessageTrack

    array<object>

    クエリ結果。

    object

    TrackType

    string

    現在のステータス。 有効な値：

    • CONSUMED：メッセージは消費されました。

    • CONSUMED_BUT_FILTERED：メッセージはグループ ID のサブスクリプション条件を満たしていなかったため、フィルターで除外され、消費されませんでした。

    • NOT_CONSUME_YET：メッセージはまだ消費されていません。

    • NOT_ONLINE：クライアントはオフラインです。

    • UNKNOWN：不明なエラーが発生しました。

    CONSUMED
    ConsumerGroup

    string

    Topic をサブスクライブするコンシューマーのグループ ID。

    GID_test_group_id
    InstanceId

    string

    メッセージが属するインスタンスの ID。

    MQ_INST_111111111111_DOxxxxxx

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "EAE5BE23-37A1-4354-94D6-E44AE17E****",
  "Data": {
    "MessageTrack": [
      {
        "TrackType": "CONSUMED",
        "ConsumerGroup": "GID_test_group_id",
        "InstanceId": "MQ_INST_111111111111_DOxxxxxx"
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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