OnsTopicSubDetail API 概要 - ApsaraMQ for RocketMQ

指定された Topic をサブスクライブしているオンラインの使用者グループをクエリします。

操作説明

説明

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

この操作を呼び出して、指定された 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:QueryTopicSubDetail

get

Topic

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

Topic

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

なし

mq:OnsInstanceBaseInfo

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	クエリ対象の Topic が含まれるインスタンス ID。	MQ_INST_111111111111_DOxxxxxx
Topic	string	必須	クエリ対象の Topic 名。	test

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。このパラメーターは共通パラメーターです。各リクエストに一意の ID が付与されます。この ID を使用して、問題のトラブルシューティングを行うことができます。	87B6207F-2908-42B5-A134-84956DCA****
Data	object	返されたデータ。
SubscriptionDataList	object
SubscriptionDataList	array<object>	Topic をサブスクライブしているオンラインの使用者グループに関する情報。
	object
GroupId	string	Topic をサブスクライブしている使用者グループ ID。	GID_test
MessageModel	string	消費モード。有効な値は次のとおりです： CLUSTERING：クラスター消費モード BROADCASTING：ブロードキャスト消費モード消費モードの詳細については、「クラスター消費とブロードキャスト消費」をご参照ください。	CLUSTERING
SubString	string	使用者グループ内のコンシューマーが Topic をサブスクライブする際の基準となる式。	*
Online	string	使用者グループがオンラインであるかどうかを示します。	true
Topic	string	Topic 名。	test

例

成功レスポンス

JSONJSON

{
  "RequestId": "87B6207F-2908-42B5-A134-84956DCA****",
  "Data": {
    "SubscriptionDataList": {
      "SubscriptionDataList": [
        {
          "GroupId": "GID_test",
          "MessageModel": "CLUSTERING",
          "SubString": "*",
          "Online": "true"
        }
      ]
    },
    "Topic": "test"
  }
}

エラーコード

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

変更履歴

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