全部產品
Search
文件中心

:OnsTraceQueryByMsgKey - 根據Message Key建立軌跡查詢任務

更新時間:Dec 12, 2025

通過傳入Topic名稱和Message Key建立軌跡查詢任務,得到該查詢任務的ID。您需要再調用OnsTraceGetResult介面,傳入返回的查詢任務ID,擷取訊息軌跡的詳細結果。

介面說明

重要 阿里雲提供的 OpenAPI 屬於管控類 API,用於管理和查詢阿里雲服務的相關資源。僅推薦在管控鏈路整合,訊息收發的核心資料鏈路中嚴禁依賴 OpenAPI 實現,否則可能會導致鏈路產生風險。

調試

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

調試

授權資訊

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

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

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

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

mq:QueryTrace

get

Topic

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

Topic

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

  • mq:OnsInstanceBaseInfo

請求參數

名稱

類型

必填

描述

樣本值

Topic

string

需查詢的訊息的 Topic。

test

MsgKey

string

需查詢的訊息的 Message Key。

ORDERID_100

BeginTime

integer

查詢的時間範圍的起始時間戳記,單位:毫秒。

1570852800000

EndTime

integer

查詢的時間範圍的結束時間戳記,單位:毫秒。

1570968000000

InstanceId

string

需查詢的訊息的 Topic 所對應的執行個體 ID。

MQ_INST_111111111111_DOxxxxxx

返回參數

名稱

類型

描述

樣本值

object

RequestId

string

公用參數,每個請求的 ID 都是唯一的,可用於排查和定位問題。

F8654231-122A-4DBD-801F-38E35538****

QueryId

string

該查詢任務的 ID。您需要根據該任務 ID 再調用 OnsTraceGetResult 介面擷取詳細結果。

272967562652883649157096685****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "F8654231-122A-4DBD-801F-38E35538****",
  "QueryId": "272967562652883649157096685****"
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情