OnsConsumerResetOffset - - Alibaba Cloud ドキュメントセンター

操作説明

説明

Alibaba Cloud が提供する API 操作は、Alibaba Cloud サービスのリソースを管理およびクエリするために使用されます。これらの API 操作は、管理システムにのみ統合することを推奨します。メッセージングサービスのコアシステムでは、これらの API 操作を使用しないでください。使用した場合、システムリスクが発生する可能性があります。

この操作を呼び出して、滞留メッセージをクリアしたり、コンシューマオフセットを指定のタイムスタンプにリセットしたりできます。滞留メッセージをクリアするには、次のいずれかのメソッドを使用できます：

指定された Topic のすべての滞留メッセージをクリアします。
指定された時点より前に指定された Topic に発行されたメッセージをクリアします。

今すぐお試しください

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

get

Topic

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

Topic

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

なし

mq:OnsInstanceBaseInfo

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
GroupId	string	必須	デッドレターメッセージをクエリするコンシューマーグループの ID。	GID_test_consumer_id
Topic	string	必須	コンシューマオフセットをリセットする Topic の名前。	test-mq-topic
Type	integer	必須	滞留メッセージをクリアするために使用するメソッド。有効な値： 0：すべての滞留メッセージがクリアされます。消費されていないメッセージは無視されます。指定されたコンシューマーグループのコンシューマーは、指定された時点以降に Topic に発行されたメッセージのみを消費します。「reconsumeLater」が返された場合、システムがコンシューマーへのメッセージの再送をリトライしているため、滞留メッセージはクリアされません。 1：指定された時点より前に Topic に発行されたメッセージがクリアされます。時点を指定する必要があります。指定されたコンシューマーグループのコンシューマーは、指定された時点以降に Topic に発行されたメッセージのみを消費します。 Topic にメッセージが発行された最も早い時点から最も新しい時点までの範囲で時点を指定できます。許可された時間範囲外の時点は無効です。	1
ResetTimestamp	integer	任意	コンシューマオフセットをリセットするタイムスタンプ。このパラメーターは、Type パラメーターが 1 に設定されている場合にのみ有効です。単位：ミリ秒。	1591153871000
InstanceId	string	任意	コンシューマーグループが属するインスタンスの ID。	MQ_INST_111111111111_DOxxxxxx

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。これは共通パラメーターです。各リクエストには一意の ID があります。この ID を使用して、問題のトラブルシューティングを行うことができます。	D52C68F8-EC5D-4294-BFFF-1A6A25AF****

例

成功レスポンス

JSONJSON

{
  "RequestId": "D52C68F8-EC5D-4294-BFFF-1A6A25AF****"
}

エラーコード

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

変更履歴

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