すべてのプロダクト
Search
ドキュメントセンター

ApsaraMQ for RocketMQ:メッセージの消費状況を確認する操作

最終更新日:Jul 09, 2024

この操作では、メッセージの消費状況を確認できます。

リクエストの構造

  • リクエスト行

    DELETE /topics/TopicName/messages? ns=INSTANCE_ID&consumer=GID HTTP/1.1

    次の表に、リクエストラインのパラメーターを示します。

    パラメーター

    必須

    説明

    TopicName

    メッセージの送信先のトピックの名前。

    ns

    任意

    インスタンス ID 。 名前空間を持つ新しいインスタンスに必要です。 コンソールの [インスタンス] ページで、インスタンスに名前空間があるかどうかを確認できます。 インスタンスは、名前空間があるかどうかに応じて、デフォルトインスタンスと新しいインスタンスに分類されます。

    • デフォルトインスタンス: 名前空間がありません。 このデフォルトインスタンスのすべてのリソース名はグローバルに一意である必要があります。

    • 新しいインスタンス: 名前空間があります。 リソース名は、このインスタンス内で一意である必要があります。

    詳細は、「インスタンスの使用」をご参照ください。

    consumer

    コンシューマーのグループID。

  • リクエストコンテンツ (XML形式)

    次の表に、リクエストコンテンツのパラメーターを示します。

    パラメーター

    必須

    説明

    ReceiptHandle

    [メッセージの消費操作] で取得したメッセージハンドル。 メッセージが正常に消費されたかどうかを確認するために使用されます。 メッセージハンドルは1回だけ使用できます。 同じメッセージの消費再試行で得られるメッセージハンドルは異なる。 メッセージハンドルは、NextConsumeTimeの前に使用する必要があります。

レスポンス構造

  • 成功したリクエスト

    • ステータス行

      HTTP/1.1 204

    • 応答コンテンツ

      なし

  • 失敗したリクエスト

    • ステータス行

      HTTP/1.1 404

    • 応答コンテンツ

      詳細については、「サンプル応答」をご参照ください。

  • リクエストのサンプル

    <? xml version="1.0" encoding="UTF-8"? >
    <ReceiptHandles xmlns=" http://mq.aliyuncs.com/doc/v1/ ">
    <ReceiptHandle>1E057D5E6EAD42A57993704EC383 ****-MTI5NT ****</ReceiptHandle>
    <ReceiptHandle>1E057D5E6EAD42A57993704EC383 ****-MTI5NT ****</ReceiptHandle>
    <ReceiptHandle>1E057D5E6EAD42A57993704EC383 ****-MTI5NT ****</ReceiptHandle>
    </ReceiptHandles> 
  • レスポンスの例

    • リクエストコンテンツにはハンドルが含まれていません。

      <? xml version="1.0" ? >
          <エラーxmlns=" http://mq.aliyuncs.com/doc/v1 ">
      <Code>MissingReceiptHandle</Code>
      <メッセージ> ReceiptHandleが必要です。 </メッセージ>
      <RequestId>5DAEF2B9463541AD6E04490F</RequestId>
      <HostId>http://123.mqrest.cn-hangzhou.aliyuncs.com</HostId>
          </エラー> 
    • リクエストハンドルが正しくありません (adfadfadf) 。

          <? xml version="1.0" ? >
          <Errors xmlns="http://mq.aliyuncs.com/doc/v1">
      <Error>
              <ErrorCode>ReceiptHandleError</ErrorCode>
              <ErrorMessage>The receipt handle you provide is not valid. </ErrorMessage>
              <ReceiptHandle>adfadfadf</ReceiptHandle>
      </Error>
          </Errors>                
    • リクエストハンドルの有効期限が切れました。これは、NextConsumeTimeの後にメッセージを確認するためにハンドルが使用されていることを示します。

          <? xml version="1.0" ? >
          <Errors xmlns="http://mq.aliyuncs.com/doc/v1">
      <Error>
              <ErrorCode>MessageNotExist</ErrorCode>
              <ErrorMessage>The receipt handle you provided has expired. </ErrorMessage>
              <ReceiptHandle>1E057D5E6EAD42A57993704EC383****-MTI5NT****</ReceiptHandle>
      </Error>
          </Errors>