すべてのプロダクト
Search
ドキュメントセンター

:OnsTraceGetResult

最終更新日:Dec 12, 2025

タスク ID を使用して、メッセージトレースクエリタスクの結果をフェッチします。

操作説明

重要 Alibaba Cloud OpenAPI は管理 API です。 Alibaba Cloud サービスのリソースを管理およびクエリするために使用します。 この API は管理目的でのみ統合してください。 メッセージの送受信にコアデータリンクでこの API を使用しないでください。データリンクに脅威をもたらす可能性があります。
  • OnsTraceQueryByMsgId または OnsTraceQueryByMsgKey 操作を呼び出してメッセージトレースクエリタスクを作成すると、タスク ID が返されます。 その後、この操作を呼び出してメッセージトレースの詳細を取得できます。 タスク ID は、作成操作によって返される QueryId です。

  • メッセージトレースクエリタスクには時間がかかります。 タスクを作成した直後にこの操作を呼び出すと、クエリが空の結果を返す場合があります。 この場合は、しばらく待ってから呼び出しをリトライしてください。

今すぐお試しください

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

get

*Topic

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

*Topic

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

なし
  • mq:QueryInstanceBaseInfo

リクエストパラメーター

パラメーター

必須 / 任意

説明

QueryId

string

必須

メッセージトレースクエリの結果をフェッチするタスクの ID。

272967562652883649157096685****

InstanceId

string

任意

クエリ対象のメッセージが含まれるインスタンスの ID。

MQ_INST_111111111111_DOxxxxxx

Topic

string

任意

クエリ対象のメッセージの Topic。

test

レスポンスフィールド

フィールド

説明

object

RequestId

string

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

84EE24D2-851F-40D6-B99E-4D6AB909****

TraceData

object

クエリタスクの結果の詳細。

Status

string

クエリタスクの結果。 有効な値:

  • finish:クエリは完了しています。

  • working:クエリは進行中です。

  • removed:タスクは削除されました。

finish

MsgKey

string

クエリタスクに対応するメッセージキー。

ORDERID_100

UpdateTime

integer

クエリタスクの最終更新時間。

1570966877000

CreateTime

integer

クエリタスクの作成時間。

1570966857000

Topic

string

クエリタスクの Topic。

test

UserId

string

クエリを開始したユーザーの ID。

27296756265288****

InstanceId

string

インスタンス ID。

MQ_INST_111111111111_DOxxxxxx

MsgId

string

クエリタスクに対応するメッセージ ID。

1E05791C117818B4AAC23B1BB0CE****

TraceList

object

TraceMapDo

array<object>

クエリタスクに一致したメッセージトレースのリスト。

array<object>

Status

string

送信ステータス。 有効な値:

  • SEND_SUCCESS:メッセージは正常に送信されました。

  • SEND_FAILED:メッセージの送信に失敗しました。

  • SEND_ROLLBACK:トランザクションメッセージはロールバックされました。

  • SEND_UNKNOWN:トランザクションメッセージはコミットされませんでした。

  • SEND_DELAY:スケジュールされたメッセージまたは遅延メッセージが送信を待機しています。

SEND_SUCCESS

MsgKey

string

メッセージキー。

ORDERID_100

PubTime

integer

メッセージが送信された時間。

1570850870478

SubList

object

SubMapDo

array<object>

メッセージの消費トレースのリスト。

array<object>

ClientList

object

SubClientInfoDo

array<object>

グループ ID に属するクライアントの消費レコードのリスト。

object

Status

string

消費ステータス。 有効な値:

  • CONSUME_FAILED:メッセージの消費に失敗しました。

  • CONSUME_SUCCESS:メッセージは正常に消費されました。

  • CONSUME_NOT_RETURN:消費結果が返されませんでした。

  • SEND_UNKNOWN:トランザクションメッセージはコミットされませんでした。

  • SEND_DELAY:スケジュールされたメッセージまたは遅延メッセージが送信を待機しています。

CONSUME_SUCCESS

SubTime

integer

消費が開始されたときの UNIX タイムスタンプ。

1570851590511

ReconsumeTimes

integer

この消費の配信試行回数。

1

SubGroupName

string

クライアントが属するグループ ID。

GID_test

ClientHost

string

コンシューマークライアントのアドレス。

30.5.**.**

CostTime

integer

この消費にかかった時間 (ミリ秒単位)。

43

FailCount

integer

グループ ID の消費失敗回数。

0

SubGroupName

string

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

GID_test

SuccessCount

integer

グループ ID の消費成功回数。

1

Topic

string

メッセージの Topic。

test

CostTime

integer

メッセージの送信にかかった時間 (ミリ秒単位)。

24

Tag

string

メッセージタグ。

TagA

MsgId

string

メッセージ ID。

0BC1F01800002A9F000000531246****

PubGroupName

string

プロデューサークライアントで設定されたグループ ID。

GID_test

BornHost

string

プロデューサークライアントのアドレス。

30.5.**.**

QueryId

string

クエリタスクの ID。

272967562652883649157096685****

成功レスポンス

JSONJSON

{
  "RequestId": "84EE24D2-851F-40D6-B99E-4D6AB909****",
  "TraceData": {
    "Status": "finish",
    "MsgKey": "ORDERID_100",
    "UpdateTime": 1570966877000,
    "CreateTime": 1570966857000,
    "Topic": "test",
    "UserId": "27296756265288****",
    "InstanceId": "MQ_INST_111111111111_DOxxxxxx",
    "MsgId": "1E05791C117818B4AAC23B1BB0CE****",
    "TraceList": {
      "TraceMapDo": [
        {
          "Status": "SEND_SUCCESS",
          "MsgKey": "ORDERID_100",
          "PubTime": 1570850870478,
          "SubList": {
            "SubMapDo": [
              {
                "ClientList": {
                  "SubClientInfoDo": [
                    {
                      "Status": "CONSUME_SUCCESS",
                      "SubTime": 1570851590511,
                      "ReconsumeTimes": 1,
                      "SubGroupName": "GID_test",
                      "ClientHost": "30.5.**.**",
                      "CostTime": 43
                    }
                  ]
                },
                "FailCount": 0,
                "SubGroupName": "GID_test",
                "SuccessCount": 1
              }
            ]
          },
          "Topic": "test",
          "CostTime": 24,
          "Tag": "TagA",
          "MsgId": "0BC1F01800002A9F000000531246****",
          "PubGroupName": "GID_test",
          "BornHost": "30.5.**.**"
        }
      ]
    },
    "QueryId": "272967562652883649157096685****"
  }
}

エラーコード

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

変更履歴

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