すべてのプロダクト
Search

このプロダクト

    ApsaraMQ for RocketMQ:OnsTrendGroupOutputTps

    ドキュメントセンター

    ApsaraMQ for RocketMQ:OnsTrendGroupOutputTps

    最終更新日:Dec 12, 2025

    指定されたグループ ID と期間におけるメッセージ消費の統計情報を照会します。

    操作説明

    重要 Alibaba Cloud OpenAPI は、Alibaba Cloud サービスのリソースを管理・照会するためのコントロールプレーン API です。 OpenAPI はコントロールプレーンでのみ使用してください。メッセージ送受信のコアとなるデータリンクで OpenAPI を使用すると、リンクに対する脅威となる可能性があるため、使用しないでください。
    本番環境で消費データレポートを生成する場合、この操作を使用して、指定されたグループ ID の次の統計を一定期間にわたって照会できます：

    • 消費されたメッセージの総数の統計曲線

    • メッセージ消費の Transaction Per Second (TPS) の統計曲線

    アプリケーションで処理するメッセージ量が少ない、または不規則な場合、TPS で照会しても有意なデータが得られないことがあります。その場合は、消費されたメッセージの総数を照会することをお勧めします。

    今すぐお試しください

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

    get

    Group

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

    Group

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

    		 なし
    • mq:OnsInstanceBaseInfo

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    GroupId

    string

    必須

    照会するグループの ID。

    GID_test
    Topic

    string

    必須

    照会する Topic の名前。

    test
    BeginTime

    integer

    必須

    照会する期間の開始時刻。 値はミリ秒単位の UNIX タイムスタンプです。

    1570852800000
    EndTime

    integer

    必須

    照会する期間の終了時刻。 値はミリ秒単位の UNIX タイムスタンプです。

    1570868400000
    Type

    integer

    必須

    照会する情報のタイプ。 有効な値：

    • 0：消費されたメッセージの総数の統計曲線。

    • 1：メッセージ消費の TPS の統計曲線。

    0
    InstanceId

    string

    任意

    グループが属するインスタンスの ID。

    MQ_INST_111111111111_DOxxxxxx
    Period

    integer

    任意

    サンプリング期間。 単位：分。 有効な値：1、5、10。

    10

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

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

    CE57AEDC-8FD2-43ED-8E3B-1F878077****
    Data

    object

    返されたデータ。

    Records

    object

    StatsDataDo

    array<object>

    データポイント。

    object

    Y

    number

    y 軸はデータ値を表します。 データは TPS またはメッセージ総数になります。

    0
    X

    integer

    x 軸はミリ秒単位のタイムスタンプを表します。

    1570867800000
    XUnit

    string

    x 軸の単位。 時間は ms 単位で測定されます。

    ms
    YUnit

    string

    y 軸の単位。 値は、消費されたメッセージの数 (msg) またはメッセージ消費の TPS (msg/min) です。

    msg
    Title

    string

    テーブルの名前。

    TopicXXX@GID_XXXReceive Trend Chart

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "CE57AEDC-8FD2-43ED-8E3B-1F878077****",
  "Data": {
    "Records": {
      "StatsDataDo": [
        {
          "Y": 0,
          "X": 1570867800000
        }
      ]
    },
    "XUnit": "ms",
    "YUnit": "msg",
    "Title": "TopicXXX@GID_XXXReceive Trend Chart"
  }
}

    エラーコード

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

    変更履歴

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