OnsConsumerAccumulate - - Alibaba Cloud ドキュメントセンター

指定されたグループ ID のメッセージの蓄積をクエリします。結果には、積み上げメッセージ数と消費レイテンシが含まれます。

操作説明

重要 Alibaba Cloud OpenAPI は、Alibaba Cloud サービスリソースを管理およびクエリするための管理 API です。この API は管理データリンクにのみ統合してください。潜在的な脅威を避けるため、メッセージの送受信を行うコアデータリンクではこの API を使用しないでください。

本番環境でメッセージ蓄積クエリを使用して、グループ ID の消費の進捗をモニターできます。これにより、メッセージ消費ステータスとレイテンシの概要がわかります。グループ ID がサブスクライブしているすべての Topic、または個別の 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:QueryConsumerAccumulate

get

Group

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

Group

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

なし

mq:OnsInstanceBaseInfo

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
GroupId	string	必須	クエリするグループの ID。	GID_test_consumer_id
Detail	boolean	任意	各 Topic の詳細をクエリするかどうかを指定します。有効な値は次のとおりです： true：詳細をクエリします。詳細は DetailInTopicList パラメーターで返されます。 false：詳細をクエリしません。これはデフォルト値です。DetailInTopicList パラメーターは空で返されます。	true
InstanceId	string	任意	インスタンス ID。	MQ_INST_111111111111_DOxxxxxx

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。これは共通パラメーターです。各リクエストには一意の ID があります。この ID を使用して、問題の特定とトラブルシューティングを行います。	CE817BFF-B389-43CD-9419-95011AC9****
Data	object	指定されたコンシューマーのメッセージの蓄積。
ConsumeTps	number	指定されたグループ ID に属するコンシューマーインスタンスのグループのメッセージ消費の合計 TPS。	10
DelayTime	integer	グループ ID の最大メッセージ消費レイテンシ。この値は、グループ ID がサブスクライブするすべての Topic の中で最も長い消費レイテンシです。単位：ミリ秒。	10000
LastTimestamp	integer	指定されたグループ ID に属するコンシューマーインスタンスのグループで、最新に消費されたメッセージの生成時刻。単位：ミリ秒単位の UNIX タイムスタンプ。	1566231000000
TotalDiff	integer	グループ ID がサブスクライブするすべての Topic の積み上げメッセージ数。	100
Online	boolean	このグループ ID の下にコンシューマーインスタンスがオンラインであるかどうかを示します。少なくとも 1 つのコンシューマーインスタンスがオンラインの場合、グループ ID はオンラインと見なされます。有効な値は次のとおりです： true：オンライン false：オフライン	true
DetailInTopicList	object
DetailInTopicDo	array<object>	各 Topic の詳細。リクエストの Detail パラメーターが false に設定されている場合、このパラメーターは空で返されます。
	object
DelayTime	integer	この Topic の最大メッセージ消費レイテンシ。これは、Topic 内の最も古い未消費メッセージの準備完了時刻と現在時刻との時間差です。単位：ミリ秒。	10000
TotalDiff	integer	Topic 内の積み上げメッセージ数。	100
LastTimestamp	integer	Topic 内で最新に消費されたメッセージの生成時刻。単位：ミリ秒単位の UNIX タイムスタンプ。	1566231000000
Topic	string	Topic 名。	test-mq-topic

例

成功レスポンス

JSONJSON

{
  "RequestId": "CE817BFF-B389-43CD-9419-95011AC9****",
  "Data": {
    "ConsumeTps": 10,
    "DelayTime": 10000,
    "LastTimestamp": 1566231000000,
    "TotalDiff": 100,
    "Online": true,
    "DetailInTopicList": {
      "DetailInTopicDo": [
        {
          "DelayTime": 10000,
          "TotalDiff": 100,
          "LastTimestamp": 1566231000000,
          "Topic": "test-mq-topic"
        }
      ]
    }
  }
}

エラーコード

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

変更履歴

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