ListConsumerGroupSubscriptions を使用したコンシューマーグループのサブスクリプション関係のリスト表示 - ApsaraMQ for RocketMQ

使用者グループのサブスクリプション関係を一覧表示します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

rocketmq:ListConsumerGroupSubscriptions

list

*ConsumerGroup

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/{#ConsumerGroupId}

なし

リクエスト構文

GET /instances/{instanceId}/consumerGroups/{consumerGroupId}/subscriptions HTTP/1.1

パスパラメータ

パラメーター	型	必須 / 任意	説明	例
instanceId	string	必須	ApsaraMQ for RocketMQ インスタンスの ID です。	rmq-cn-tl32wwz1r05
consumerGroupId	string	必須	サブスクリプション関係をクエリする使用者グループの ID です。	PRINT_RETRY_CONSUMER

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
topicName	string	任意	Topic の名前。このパラメーターを指定しない場合、すべてのサブスクリプション関係がクエリされます。	topic_test

レスポンスフィールド

フィールド	型	説明	例
	object	Result<List>
requestId	string	リクエスト ID です。	5F4D9D5F-625B-59FF-BD4F-DA8284575DB4
success	boolean	リクエストが成功したかどうかを示します。	true
data	array<object>	返されたデータです。
	object	使用者グループのサブスクリプション関係のリストです。
consumerGroupId	string	使用者グループの ID です。	CID-TEST
topicName	string	使用者グループがサブスクライブする Topic です。	topic_test
messageModel	string	使用者グループの消費モードです。 BROADCASTING: ブロードキャスト消費モード。 CLUSTERING: クラスター消費モード。	CLUSTERING
subscriptionStatus	string	サブスクリプションのステータスです。 ONLINE: 使用者グループはオンラインです。使用者グループに複数のコンシューマーが含まれている場合、少なくとも 1 つのコンシューマーがオンラインである限り、グループはオンラインと見なされます。 OFFLINE: 使用者グループはオフラインです。使用者グループに複数のコンシューマーが含まれている場合、すべてのコンシューマーがオフラインの場合にのみ、グループはオフラインと見なされます。	ONLINE
filterExpression	string	フィルター式です。	*
filterExpressionType	string	フィルター式のタイプです。 SQL: SQL フィルタリング。 TAG: タグフィルタリング。	SQL
topicCreated	boolean	Topic が作成されたかどうかを示します。	true
consistency	boolean	サブスクリプション関係の一貫性です。 false: サブスクリプション関係に一貫性がありません。 true: サブスクリプション関係に一貫性があります。	true
code	string	エラーコードです。	MissingInstanceId
message	string	エラーメッセージです。	Parameter instanceId is mandatory for this action .
httpStatusCode	integer	HTTP ステータスコードです。	200
dynamicCode	string	動的エラーコードです。	InstanceId
dynamicMessage	string	動的エラーメッセージです。	InstanceId

例

成功レスポンス

JSONJSON

{
  "requestId": "5F4D9D5F-625B-59FF-BD4F-DA8284575DB4",
  "success": true,
  "data": [
    {
      "consumerGroupId": "CID-TEST",
      "topicName": "topic_test",
      "messageModel": "CLUSTERING",
      "subscriptionStatus": "ONLINE",
      "filterExpression": "*",
      "filterExpressionType": "SQL",
      "topicCreated": true,
      "consistency": true
    }
  ],
  "code": "MissingInstanceId",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "InstanceId"
}

エラーコード

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

変更履歴

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