GetMessageDetail API でメッセージ詳細をクエリしてデバッグ - 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:GetMessageDetail

get

*Topic

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

なし

リクエスト構文

GET /instances/{instanceId}/topics/{topicName}/messages/{messageId} HTTP/1.1

パスパラメータ

パラメーター	型	必須 / 任意	説明	例
instanceId	string	必須	インスタンスの ID です。	rmq-cn-lbj31fs790d
topicName	string	必須	Topic の名前です。	flink_test
messageId	string	必須	メッセージの ID です。	0A792FDB001F7591083D30ADB1DA11D5

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

リクエストパラメーターは必要ありません。

レスポンスフィールド

フィールド	型	説明	例
	object	結果
requestId	string	リクエストの ID です。	FAEBD71F-E839-52F9-BD7B-8F1290525841
success	boolean	リクエストが成功したかどうかを示します。	true
data	object	返されるデータです。
regionId	string	リージョンの ID です。	cn-hangzhou
instanceId	string	インスタンスの ID です。	rmq-cn-7e22ody****
topicName	string	Topic の名前です。	topic_test
messageId	string	メッセージの ID です。	01BE87E485F0C7808C04543CAF00000001
bornTime	string	メッセージが生成された時刻です。	2023-03-22 12:17:08
storeTime	string	メッセージが保存された時刻です。	2023-03-22 12:17:08
body	string	メッセージの本文です。	{}
bodySize	integer	メッセージ本文のサイズです。	123
bornHost	string	メッセージを生成したホストです。	xxx.xx.xxx.xx
storeHost	string	メッセージを保存したホストです。	xxx.xx.xxx.xx
messageType	string	メッセージのタイプです。	NORMAL
messageTag	string	メッセージのタグです。	xx
messageGroup	string	シャーディングキーです。このパラメーターは、順序指定メッセージに対してのみ返されます。	xx
messageKeys	array	メッセージのビジネスキーです。
	string	ビジネスキーです。	xx
userProperties	object	メッセージのユーザー定義プロパティです。
	string	ユーザー定義プロパティです。	xxx
systemProperties	object	メッセージのデフォルトのシステムプロパティです。
	string	デフォルトのシステムプロパティです。	xx
liteTopicName	string	軽量 Topic の名前です。	abc
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": "FAEBD71F-E839-52F9-BD7B-8F1290525841",
  "success": true,
  "data": {
    "regionId": "cn-hangzhou",
    "instanceId": "rmq-cn-7e22ody****",
    "topicName": "topic_test",
    "messageId": "01BE87E485F0C7808C04543CAF00000001",
    "bornTime": "2023-03-22 12:17:08",
    "storeTime": "2023-03-22 12:17:08",
    "body": "{}",
    "bodySize": 123,
    "bornHost": "xxx.xx.xxx.xx",
    "storeHost": "xxx.xx.xxx.xx",
    "messageType": "NORMAL",
    "messageTag": "xx",
    "messageGroup": "xx",
    "messageKeys": [
      "xx"
    ],
    "userProperties": {
      "key": "xxx"
    },
    "systemProperties": {
      "key": "xx"
    },
    "liteTopicName": "abc"
  },
  "code": "Topic.NotFound",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

エラーコード

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

変更履歴

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