すべてのプロダクト
Search

このプロダクト

    ApsaraMQ for RocketMQ:GetConsumerGroupLag

    ドキュメントセンター

    ApsaraMQ for RocketMQ:GetConsumerGroupLag

    最終更新日:Nov 06, 2025

    使用者グループのメッセージ蓄積量を照会します。

    今すぐお試しください

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

    get

    *ConsumerGroup

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

    		 なし なし

    リクエスト構文

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

    パスパラメータ

    パラメーター

    型

    必須 / 任意

    説明

    例
    instanceId

    string

    必須

    インスタンス ID。

    rmq-cn-2r42vrvde0j
    consumerGroupId

    string

    必須

    使用者グループ ID。

    CID-TEST

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    topicName

    string

    任意

    使用者グループがサブスクライブする Topic の名前。

    normal-topic-1
    liteTopicName

    string

    任意

    ライト Topic の名前。

    abc

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Result<ConsumerGroupLagDto>

    requestId

    string

    リクエスト ID。

    F5764C40-FB8C-53AE-B95D-96AB3D0E9375
    success

    boolean

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

    true
    data

    object

    返されたデータ。

    regionId

    string

    リージョン ID。

    cn-hangzhou
    instanceId

    string

    インスタンス ID。

    rmq-cn-7e22ody****
    consumerGroupId

    string

    使用者グループ ID。

    CID-TEST
    totalLag

    object

    メッセージの総蓄積量。

    readyCount

    integer

    準備完了メッセージの数。

    1
    inflightCount

    integer

    処理中のメッセージの数。

    1
    deliveryDuration

    integer

    配信レイテンシ。 単位：秒。

    12
    lastConsumeTimestamp

    integer

    最終消費のタイムスタンプ。

    1735629607846
    topicLagMap

    object

    各 Topic のメッセージ蓄積量。

    object

    メッセージ蓄積量の詳細。

    readyCount

    integer

    準備完了メッセージの数。

    1
    inflightCount

    integer

    処理中のメッセージの数。

    1
    deliveryDuration

    integer

    配信レイテンシ。 単位：秒。

    12
    lastConsumeTimestamp

    integer

    最終消費のタイムスタンプ。

    1735629607846
    topicName

    string

    サブスクライブした Topic の名前。

    test1
    liteTopicLagMap

    object

    ライト Topic のメッセージ蓄積量。

    object

    ライト Topic のメッセージ蓄積量。

    readyCount

    integer

    蓄積されたメッセージの数。

    300
    deliveryDuration

    integer

    配信レイテンシ。 単位：秒。

    30
    code

    string

    エラーコード。

    Topic.NotFound
    message

    string

    エラーメッセージ。

    Parameter instanceId is mandatory for this action .
    httpStatusCode

    integer

    HTTP ステータスコード。

    200
    dynamicCode

    string

    動的エラーコード。

    InstanceId
    dynamicMessage

    string

    動的エラーメッセージ。

    instanceId

    例

    成功レスポンス

    JSONJSON

    {
  "requestId": "F5764C40-FB8C-53AE-B95D-96AB3D0E9375",
  "success": true,
  "data": {
    "regionId": "cn-hangzhou",
    "instanceId": "rmq-cn-7e22ody****",
    "consumerGroupId": "CID-TEST",
    "totalLag": {
      "readyCount": 1,
      "inflightCount": 1,
      "deliveryDuration": 12,
      "lastConsumeTimestamp": 1735629607846
    },
    "topicLagMap": {
      "key": {
        "readyCount": 1,
        "inflightCount": 1,
        "deliveryDuration": 12,
        "lastConsumeTimestamp": 1735629607846
      }
    },
    "topicName": "test1",
    "liteTopicLagMap": {
      "key": {
        "readyCount": 300,
        "deliveryDuration": 30
      }
    }
  },
  "code": "Topic.NotFound",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

    エラーコード

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

    変更履歴

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