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

OnsMessageDetail を呼び出して、特定のメッセージの詳細をクエリできます。

操作説明

重要 Alibaba Cloud OpenAPI はコントロールプレーン API です。これを使用して、Alibaba Cloud サービスリソースを管理およびクエリできます。メッセージを送受信するコアデータリンクに OpenAPI を使用しないでください。データリンクに脅威が生じる可能性があります。

今すぐお試しください

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

get

Topic

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

Topic

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

なし

mq:OnsInstanceBaseInfo

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	ApsaraMQ for RocketMQ インスタンスの ID。	MQ_INST_184681981******_BXig0x6A
Topic	string	必須	クエリするメッセージの Topic。	test-mq_topic
MsgId	string	必須	クエリするメッセージの ID。これはメッセージ ID です。	1E0578FE110F18B4AAC235C0******

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
RequestId	string	共通パラメーター。リクエスト ID。各リクエストには一意の ID があります。この ID を使用して、問題のトラブルシューティングを行います。	EAE5BE23-37A1-4354-94D6-E44AE17E****
Data	object	クエリ結果。
StoreSize	integer	メッセージのサイズ。単位：KB。	2
ReconsumeTimes	integer	メッセージ消費がリトライされた回数。	0
StoreTimestamp	integer	メッセージがサーバー側に保存されたときの UNIX タイムスタンプ。単位：ミリ秒。	1570761026708
Body	string	メッセージ本文。Base64 でエンコードされた文字列です。	aGVsbG8=
InstanceId	string	ApsaraMQ for RocketMQ インスタンスの ID。	MQ_INST_184681981******_BXig0x6A
MsgId	string	メッセージ ID。	1E0578FE110F18B4AAC235C05F2*****
StoreHost	string	メッセージが保存されているサーバーインスタンス。	11.220.*.*:10911
Topic	string	メッセージが属する Topic。	test-mq_topic
PropertyList	array<object>	メッセージ属性のリスト。
	object
Value	string	メッセージ属性の値。	MSG_REGION
Name	string	メッセージ属性。有効な値： TRACE_ON：メッセージトレースが存在するかどうかを示します。 MSG_REGION：メッセージ Topic を含むインスタンスのリージョン ID。 __MESSAGE_DECODED_TIME：メッセージがデコードされた時間。 __BORNHOST：プロデューサーのクライアントの IP アドレス。 UNIQ_KEY：メッセージの一意の識別子。これはメッセージ ID です。詳細については、「用語」をご参照ください。	cn-hangzhou
BornTimestamp	integer	メッセージが生成されたときの UNIX タイムスタンプ。単位：ミリ秒。	1570761026630
BodyCRC	integer	メッセージ本文の巡回冗長検査 (CRC) 値。	907060870
BornHost	string	メッセージを生成したクライアントインスタンス。	42.120..:64646
BodyStr	string	メッセージ本文の内容。	hello

例

成功レスポンス

JSONJSON

{
  "RequestId": "EAE5BE23-37A1-4354-94D6-E44AE17E****",
  "Data": {
    "StoreSize": 2,
    "ReconsumeTimes": 0,
    "StoreTimestamp": 1570761026708,
    "Body": "aGVsbG8=",
    "InstanceId": "MQ_INST_184681981******_BXig0x6A",
    "MsgId": "1E0578FE110F18B4AAC235C05F2*****",
    "StoreHost": "11.220.***.***:10911",
    "Topic": "test-mq_topic",
    "PropertyList": [
      {
        "Value": "MSG_REGION",
        "Name": "cn-hangzhou"
      }
    ],
    "BornTimestamp": 1570761026630,
    "BodyCRC": 907060870,
    "BornHost": "42.120.**.**:64646",
    "BodyStr": "hello"
  }
}

エラーコード

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

変更履歴

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