すべてのプロダクト
Search

このプロダクト

    :ResetConsumeOffset

    ドキュメントセンター

    :ResetConsumeOffset

    最終更新日:Dec 21, 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:ResetConsumeOffset

    update

    *ConsumerGroup

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

    		 なし なし

    リクエスト構文

    PATCH /instances/{instanceId}/consumerGroups/{consumerGroupId}/consumeOffsets/{topicName} HTTP/1.1

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    instanceId

    string

    必須

    インスタンス ID。

    rmq-cn-tl32ue44x0g
    consumerGroupId

    string

    必須

    使用者グループ ID。

    dolphin_status
    topicName

    string

    必須

    Topic 名。

    AMZN_REPORT_TOPIC

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    body

    object

    任意

    リクエストボディ。

    resetType

    string

    任意

    コンシューマオフセットをリセットするために使用されるメソッド。有効な値： LATEST_OFFSET および SPECIFIED_TIME。

    列挙値:

    • SPECIFIED_TIME :

      指定した時間のオフセットから消費を開始します。

    • LATEST_OFFSET :

      最新のオフセットから消費を開始します。

    LATEST_OFFSET
    resetTime

    string

    任意

    コンシューマオフセットがリセットされる時間。

    2023-03-22 12:17:08

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    結果

    requestId

    string

    リクエスト ID。

    F9A95891-EAD4-5A2B-8A30-676CD18921AF
    success

    boolean

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

    true
    code

    string

    返されたエラーコード。

    MissingInstanceId
    message

    string

    返されたエラーメッセージ。

    The instance cannot be found.
    httpStatusCode

    integer

    返された HTTP ステータスコード。

    200
    dynamicCode

    string

    返された動的エラーコード。

    InstanceId
    dynamicMessage

    string

    返された動的エラーメッセージ。

    instanceId

    例

    成功レスポンス

    JSONJSON

    {
  "requestId": "F9A95891-EAD4-5A2B-8A30-676CD18921AF",
  "success": true,
  "code": "MissingInstanceId",
  "message": "The instance cannot be found.",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

    エラーコード

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

    変更履歴

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