VerifyConsumeMessage API で RocketMQ メッセージ配送を検証 - ApsaraMQ for RocketMQ

今すぐお試しください

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

update

*Topic

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}

なし

リクエスト構文

POST /instances/{instanceId}/topics/{topicName}/messages/{messageId}/action/verifyConsume HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
instanceId	string	必須	インスタンス ID。	rmq-cn-i7m2vc1vx01
topicName	string	必須	Topic 名。	delay_topic
messageId	string	必須	メッセージ ID。	A9FE190A59AA421ED014743DFDBF017D

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
consumerGroupId	string	必須	使用者グループの ID。	TEST_FINANCE_STOCK_OUT_GROUP
clientId	string	必須	クライアント ID。	zeekr-settlement-server-dc555456f-v2lcg@1@1@qfvorazqns

レスポンスフィールド

フィールド	型	説明	例
	object	結果。
requestId	string	リクエスト ID。	5304143F-AB0E-5AB4-A227-7C5489216FD5
success	boolean	リクエストが成功したかどうかを示します。	true
data	boolean	返されたデータ。	true
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": "5304143F-AB0E-5AB4-A227-7C5489216FD5",
  "success": true,
  "data": true,
  "code": "Topic.NotFound",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

エラーコード

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

変更履歴

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