使用 RocketMQ API 追蹤主題消息發佈統計 - ApsaraMQ for RocketMQ

介面說明

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

您可以使用本介面擷取線上上環境統計的 Topic 的訊息資料資訊，可以根據需要選取查詢指定時間段內 Topic 的寫入量或者 TPS 曲線資料。

如果應用方訊息量比較小，間隔不均勻，此時採用 TPS 查詢可能會導致資料不明顯，建議使用總量查詢。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

mq:QueryTrendTopicInputTps

get

Topic

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

Topic

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

無

mq:OnsInstanceBaseInfo

請求參數

名稱	類型	必填	描述	樣本值
Topic	string	是	需查詢的 Topic 名稱。	test
BeginTime	integer	是	查詢區間的起始時間戳記，單位：毫秒。	1570852800000
EndTime	integer	是	查詢區間的終止時間戳記，單位：毫秒。	1570868400000
Type	integer	是	查詢的類型。取值說明如下： 0：查詢指定時間段內 Topic 的寫入量。 1：查詢指定時間段內 Topic 的 TPS 曲線資料。	0
InstanceId	string	否	指定的 Topic 所對應的執行個體 ID。	MQ_INST_111111111111_DOxxxxxx
Period	integer	否	採樣周期，單位：分鐘，取值可為 1、5、10。	10

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	公用參數，每個請求的 ID 都是唯一的，可用於排查和定位問題。	E213AD8A-0730-4B3D-A35A-340DA47D****
Data	object	資料集合。
Records	object
StatsDataDo	array<object>	採集點資訊。
	object
Y	number	縱軸，資料（TPS 或者總量）。	0
X	integer	橫軸，時間戳記，單位：毫秒。	1570852800000
XUnit	string	橫軸單位。統計時間：ms。	ms
YUnit	string	縱軸單位。統計的訊息生產數量 msg，或者統計的訊息生產 TPS msg/min。	msg
Title	string	Table 的名稱。	TopicXXX Send Trend Chart

樣本

正常返回樣本

JSON格式

{
  "RequestId": "E213AD8A-0730-4B3D-A35A-340DA47D****",
  "Data": {
    "Records": {
      "StatsDataDo": [
        {
          "Y": 0,
          "X": 1570852800000
        }
      ]
    },
    "XUnit": "ms",
    "YUnit": "msg",
    "Title": "TopicXXX  Send Trend Chart"
  }
}

錯誤碼

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

變更歷史

更多資訊，參考變更詳情。