すべてのプロダクト
Search

このプロダクト

    :ListConsumerGroups

    ドキュメントセンター

    :ListConsumerGroups

    最終更新日:Nov 06, 2025

    指定されたインスタンス内の使用者グループを一覧表示します。

    操作説明

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

    今すぐお試しください

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

    list

    *ConsumerGroup

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

    		 なし なし

    リクエスト構文

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

    パスパラメータ

    パラメーター

    型

    必須 / 任意

    説明

    例
    instanceId

    string

    必須

    インスタンスの ID です。

    rmq-cn-7e22ody****

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    filter

    string

    任意

    フィルター条件。このパラメーターを指定しない場合、インスタンス内のすべての使用者グループが返されます。

    CID-TEST
    pageNumber

    integer

    任意

    返す結果のページ番号です。

    1
    pageSize

    integer

    任意

    各ページで返すエントリ数です。

    有効な値: 10～100。

    10

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Result<MyPage<ConsumerGroupDto>>

    requestId

    string

    リクエスト ID。各リクエストには一意の ID があります。この ID を使用して問題をトラブルシューティングできます。

    5503A460-98ED-5543-92CF-4853DE28****
    success

    boolean

    リクエストが成功したかどうかを示します。

    true
    data

    object

    返されたデータ。

    pageNumber

    integer

    現在のページ番号。

    1
    pageSize

    integer

    ページごとに返されるエントリ数。

    10
    totalCount

    integer

    返されたエントリの総数。

    1
    list

    array<object>

    現在のページで返されたデータ。

    object

    regionId

    string

    インスタンスが存在するリージョンの ID。

    cn-hangzhou
    instanceId

    string

    インスタンス ID。

    rmq-cn-7e22ody****
    consumerGroupId

    string

    使用者グループ ID。

    GID-TEST
    status

    string

    使用者グループのステータス。

    列挙値:

    • RUNNING :

      使用者グループは実行中です。

    • CREATING :

      使用者グループは作成中です。

    RUNNING
    remark

    string

    使用者グループに関する備考。

    This is the remark for test.
    createTime

    string

    使用者グループが作成された時間。

    2022-08-01 20:05:50
    updateTime

    string

    使用者グループが最後に更新された時間。

    2022-08-01 20:05:50
    maxReceiveTps

    integer

    メッセージ消費の最大秒間トランザクション数 (TPS)。

    1000
    messageModel

    string

    消費モード。

    LITE_SELECTIVE
    topicName

    string

    ライト使用者グループの Topic の名前。

    test1
    code

    string

    エラーコード。

    MissingInstanceId
    message

    string

    エラーメッセージ。

    Parameter InstanceId is mandatory for this action .
    httpStatusCode

    integer

    HTTP ステータスコード。

    400
    dynamicCode

    string

    動的エラーコード。

    InstanceId
    dynamicMessage

    string

    動的エラーメッセージ。

    instanceId

    例

    成功レスポンス

    JSONJSON

    {
  "requestId": "5503A460-98ED-5543-92CF-4853DE28****",
  "success": true,
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 1,
    "list": [
      {
        "regionId": "cn-hangzhou",
        "instanceId": "rmq-cn-7e22ody****",
        "consumerGroupId": "GID-TEST",
        "status": "RUNNING",
        "remark": "This is the remark for test.",
        "createTime": "2022-08-01 20:05:50",
        "updateTime": "2022-08-01 20:05:50",
        "maxReceiveTps": 1000,
        "messageModel": "LITE_SELECTIVE",
        "topicName": "test1"
      }
    ]
  },
  "code": "MissingInstanceId",
  "message": "Parameter InstanceId is mandatory for this action .",
  "httpStatusCode": 400,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

    エラーコード

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

    変更履歴

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