すべてのプロダクト
Search

このプロダクト

    ApsaraMQ for RocketMQ:OnsDLQMessagePageQueryByGroupId

    ドキュメントセンター

    ApsaraMQ for RocketMQ:OnsDLQMessagePageQueryByGroupId

    最終更新日:Dec 12, 2025

    指定されたグループ ID と時間範囲に基づいて、デッドレターメッセージをページ単位でクエリします。

    操作説明

    重要 Alibaba Cloud OpenAPI は管理用 API です。 Alibaba Cloud サービスリソースの管理とクエリに使用できます。 この API は管理目的でのみ統合してください。 メッセージを送受信するコアデータリンクにこの API を使用すると、セキュリティ上の脅威が生じる可能性があるため、使用しないでください。

    • グループ ID によるデッドレターメッセージのクエリは、ページング範囲クエリです。 このメソッドは、メッセージ ID を指定せずにメッセージをクエリするシナリオにのみ適用されます。

    • グループ ID でデッドレターメッセージをクエリする場合、できるだけ短い時間範囲を指定してください。 時間範囲が長いと、返されるメッセージが多すぎて問題の特定が困難になる可能性があります。 呼び出しフローは次のとおりです：

      1. 最初のページングクエリでは、グループ ID、開始時刻、終了時刻、および 1 ページあたりのメッセージ数を指定します。 メッセージが見つかった場合、API は最初のページのメッセージ、総ページ数、およびクエリタスク ID を返します。

      2. 返されたクエリタスク ID を使用して、メッセージの次のページを取得します。 後続のリクエストでは、クエリタスク ID とページ番号を指定します。 これらのリクエストの開始時刻、終了時刻、および 1 ページあたりのメッセージ数は、最初のクエリの値が使用されるため無視されます。

    今すぐお試しください

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

    get

    Group

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

    Group

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

    		 なし
    • mq:OnsInstanceBaseInfo

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    GroupId

    string

    必須

    クエリ対象の使用者グループの ID。

    GID_test_group_id
    BeginTime

    integer

    必須

    クエリする時間範囲の開始時刻。 この値はミリ秒単位の UNIX タイムスタンプです。 TaskId を指定して後続のページを取得する場合、このパラメーターは無視されます。 最初のクエリの開始時刻が使用されます。

    1570723200000
    EndTime

    integer

    必須

    クエリする時間範囲の終了時刻。 この値はミリ秒単位の UNIX タイムスタンプです。 TaskId を指定して後続のページを取得する場合、このパラメーターは無視されます。 最初のクエリの終了時刻が使用されます。

    1570809600000
    TaskId

    string

    任意

    クエリタスクの ID。 最初のクエリではこのパラメーターを省略します。 後続のクエリでは、前のクエリで返されたタスク ID を使用します。

    0BC1310300002A9F000021E4D7A48346
    CurrentPage

    integer

    必須

    返すページ番号。 ページは 1 から始まります。 値は最大 50 で、総ページ数を超えてはなりません。

    2
    PageSize

    integer

    任意

    各ページで返すメッセージの数。 デフォルト値：20。 最小値：5。 最大値：50。 TaskId を指定して後続のページを取得する場合、このパラメーターは無視されます。 最初のクエリのページサイズが使用されます。

    5
    InstanceId

    string

    任意

    メッセージが含まれるインスタンスの ID。

    MQ_INST_111111111111_DOxxxxxx

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

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

    B00CD3C8-D81E-4A41-85E2-38F19252****
    MsgFoundDo

    object

    クエリ結果。

    CurrentPage

    integer

    現在のページ番号。

    1
    MsgFoundList

    object

    OnsRestMessageDo

    array<object>

    現在のページのメッセージのリスト。 データ型は、OnsDLQMessageGetById 操作への応答のデータ型と同じです。

    array<object>

    StoreSize

    integer

    メッセージサイズ (KB)。

    406
    ReconsumeTimes

    integer

    メッセージが再消費された回数。

    1
    StoreTimestamp

    integer

    メッセージがサーバーに保存されたときの UNIX タイムスタンプ。

    1570760999811
    InstanceId

    string

    インスタンス ID。

    MQ_INST_111111111111_DOxxxxxx
    MsgId

    string

    メッセージ ID。

    1E0578FE110F18B4AAC235C05F2*****
    StoreHost

    string

    メッセージを保存するサーバー。

    11.193.***.***:10911
    Topic

    string

    メッセージの Topic。

    test-mq_topic
    PropertyList

    object

    MessageProperty

    array<object>

    メッセージプロパティのリスト。

    object

    Value

    string

    メッセージプロパティの値。

    TagA
    Name

    string

    メッセージプロパティ。 有効な値：

    • TRACE_ON：メッセージトレースが存在するかどうかを示します。

    • KEYS：メッセージのキー。

    • TAGS：メッセージのタグ。

    • INSTANCE_ID：メッセージが含まれるインスタンスの ID。

    詳細については、「用語」をご参照ください。

    TAGS
    BornTimestamp

    integer

    メッセージが生成されたときの UNIX タイムスタンプ。

    1570760999721
    BodyCRC

    integer

    メッセージ本文の巡回冗長検査 (CRC) 値。

    914112295
    BornHost

    string

    メッセージを生成したプロデューサー。

    42.120.***.***:59270
    MaxPageCount

    integer

    利用可能な総ページ数。

    400
    TaskId

    string

    クエリタスクの ID。 この ID は最初のクエリで返されます。 この ID を使用して後続のページを取得します。

    0BC1310300002A9F000021E4D7A48346

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "B00CD3C8-D81E-4A41-85E2-38F19252****",
  "MsgFoundDo": {
    "CurrentPage": 1,
    "MsgFoundList": {
      "OnsRestMessageDo": [
        {
          "StoreSize": 406,
          "ReconsumeTimes": 1,
          "StoreTimestamp": 1570760999811,
          "InstanceId": "MQ_INST_111111111111_DOxxxxxx",
          "MsgId": "1E0578FE110F18B4AAC235C05F2*****",
          "StoreHost": "11.193.***.***:10911",
          "Topic": "test-mq_topic",
          "PropertyList": {
            "MessageProperty": [
              {
                "Value": "TagA",
                "Name": "TAGS"
              }
            ]
          },
          "BornTimestamp": 1570760999721,
          "BodyCRC": 914112295,
          "BornHost": "42.120.***.***:59270"
        }
      ]
    },
    "MaxPageCount": 400,
    "TaskId": "0BC1310300002A9F000021E4D7A48346"
  }
}

    エラーコード

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

    変更履歴

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