全部產品
Search
文件中心

:OnsTraceGetResult - 擷取軌跡查詢結果

更新時間:Dec 12, 2025

通過傳入軌跡查詢任務的ID擷取之前的軌跡查詢結果。

介面說明

重要 阿里雲提供的 OpenAPI 屬於管控類 API,用於管理和查詢阿里雲服務的相關資源。僅推薦在管控鏈路整合,訊息收發的核心資料鏈路中嚴禁依賴 OpenAPI 實現,否則可能會導致鏈路產生風險。
  • 若您已根據 Message ID 或者 Message Key 建立了軌跡查詢任務,並得到了查詢任務的 ID。您可調用本介面根據查詢任務 ID 擷取對應的軌跡結果的明細。軌跡查詢任務通過 OnsTraceQueryByMsgIdOnsTraceQueryByMsgKey 介面建立,返回資料中的 QueryId 即為本介面中需要傳入的查詢任務 ID。

  • 因為訊息軌跡查詢任務耗時較多,建立任務後立即根據該介面擷取結果可能為空白,若遇到此情況,建議等待一段時間再重試。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

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 都是唯一的,可用於排查和定位問題。

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

TraceData

object

該查詢任務的結果明細。

Status

string

該查詢任務的結果。取值說明如下:

  • finish:查詢完成

  • working:查詢中

  • removed:任務已刪除

finish

MsgKey

string

該查詢任務對應的 Message Key。

ORDERID_100

UpdateTime

integer

該查詢任務的最後更新時間。

1570966877000

CreateTime

integer

該查詢任務的建立時間。

1570966857000

Topic

string

該查詢任務的 Topic。

test

UserId

string

查詢使用者識別碼。

27296756265288****

InstanceId

string

執行個體 ID。

MQ_INST_111111111111_DOxxxxxx

MsgId

string

該查詢任務對應的 Message 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

訊息的 Key ,即 Message Key。

ORDERID_100

PubTime

integer

訊息發送時間。

1570850870478

SubList

object

SubMapDo

array<object>

訊息的消費軌跡列表。

array<object>

ClientList

object

SubClientInfoDo

array<object>

該 Group ID 用戶端消費記錄的明細列表。

object

Status

string

消費狀態。取值說明如下:

  • CONSUME_FAILED:消費失敗

  • CONSUME_SUCCESS:消費成功

  • CONSUME_NOT_RETURN:消費未返回結果

  • SEND_UNKNOWN:事務訊息未提交

  • SEND_DELAY:定時(延時)訊息定時中

CONSUME_SUCCESS

SubTime

integer

消費開始時間戳。

1570851590511

ReconsumeTimes

integer

本次消費的投遞輪次。

1

SubGroupName

string

該用戶端所屬的 Group ID。

GID_test

ClientHost

string

消費用戶端的用戶端地址。

30.5.**.**

CostTime

integer

本次消費耗時,單位毫秒。

43

FailCount

integer

該 Group ID 消費失敗次數統計。

0

SubGroupName

string

消費方 Group ID。

GID_test

SuccessCount

integer

該 Group ID 消費成功次數統計。

1

Topic

string

訊息的 Topic。

test

CostTime

integer

發送耗時,單位毫秒。

24

Tag

string

訊息的 Tag,即 Message Tag。

TagA

MsgId

string

訊息的 ID,即 Message ID。

0BC1F01800002A9F000000531246****

PubGroupName

string

發送方用戶端配置的 Group ID。

GID_test

BornHost

string

訊息發送方的用戶端地址。

30.5.**.**

QueryId

string

查詢任務 ID。

272967562652883649157096685****

樣本

正常返回樣本

JSON格式

{
  "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****"
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情