コンシューマグループサブスクリプション向け OnsGroupSubDetail API 概要 - ApsaraMQ for RocketMQ

操作説明

重要 Alibaba Cloud が提供する OpenAPI は、Alibaba Cloud サービスのリソースを管理およびクエリするための管理 API です。OpenAPI は管理データリンクにのみ統合してください。メッセージの送受信を行うコアデータリンクで OpenAPI を使用すると、データリンクにリスクをもたらす可能性があるため、使用しないでください。

今すぐお試しください

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

get

Group

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

Group

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

なし

mq:OnsInstanceBaseInfo

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	グループが属するインスタンスの ID。	MQ_INST_111111111111_DOxxxxxx
GroupId	string	必須	クエリするグループの ID。	GID_test_group_id

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	共通パラメーター。リクエストの ID です。各リクエストには一意の ID があり、この ID を使用して問題のトラブルシューティングを行うことができます。	3364E875-013B-442A-BC3C-C1A84DC6****
Data	object	返された Data オブジェクト。
SubscriptionDataList	object
SubscriptionDataList	array<object>	指定されたグループ ID のコンシューマーインスタンスがオフラインの場合、データはクエリできません。
	object
SubString	string	サブスクリプション式。	*
Topic	string	グループがサブスクライブする Topic。	test-mq_topic
GroupId	string	クエリするグループの ID。	GID_test_group_id
MessageModel	string	消費パターン。有効な値： CLUSTERING：クラスター消費 BROADCASTING：ブロードキャスト消費消費パターンの詳細については、「クラスター消費とブロードキャスト消費」をご参照ください。	CLUSTERING
Online	boolean	コンシューマーがオンラインであるかどうかを示します。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "3364E875-013B-442A-BC3C-C1A84DC6****",
  "Data": {
    "SubscriptionDataList": {
      "SubscriptionDataList": [
        {
          "SubString": "*",
          "Topic": "test-mq_topic"
        }
      ]
    },
    "GroupId": "GID_test_group_id",
    "MessageModel": "CLUSTERING",
    "Online": true
  }
}

エラーコード

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

変更履歴

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