RocketMQ API を使用したトピックメッセージ公開統計の追跡 - ApsaraMQ for RocketMQ

操作説明

説明

Alibaba Cloud が提供する API 操作は、Alibaba Cloud サービスのリソースを管理および照会するために使用されます。これらの API 操作は、管理システムにのみ統合することを推奨します。メッセージングサービスのコアシステムでは、これらの API 操作を使用しないでください。使用した場合、システムリスクが発生する可能性があります。

この操作を呼び出すことで、本番環境の特定の Topic に発行されたメッセージの統計を照会できます。ビジネス要件に基づいて、指定された時間範囲内に Topic に発行されたメッセージ数、またはメッセージ発行の TPS を照会できます。

アプリケーションが発行するメッセージ数が少なく、特定の間隔でメッセージを発行しない場合は、TPS の統計では明確な変化の傾向が示されない可能性があるため、各サンプリング期間中に Topic に発行されたメッセージ数を照会することを推奨します。

今すぐお試しください

この 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: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。これは共通パラメーターです。各リクエストには一意の ID があります。この ID を使用して、問題をトラブルシューティングできます。	E213AD8A-0730-4B3D-A35A-340DA47D****
Data	object	返されるデータ。
Records	object
StatsDataDo	array<object>	サンプリング期間に基づいて返されるデータセット。
	object
Y	number	Y 軸。このパラメーターは、メッセージ発行の TPS または発行されたメッセージ数を示します。	0
X	integer	X 軸。このパラメーターの値は、ミリ秒単位の UNIX タイムスタンプです。	1570852800000
XUnit	string	タイムスタンプの単位。	ms
YUnit	string	Y 軸の単位。	msg
Title	string	テーブルの名前。	TopicXXX Send Trend Chart

例

成功レスポンス

JSONJSON

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

エラーコード

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

変更履歴

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