Gunakan OnsMessageGetByMsgId untuk melacak pengiriman pesan berdasarkan ID - ApsaraMQ for RocketMQ - Alibaba Cloud - ApsaraMQ for RocketMQ

Mengkueri informasi tentang Paket dengan menentukan ID Paket dan mengetahui apakah Paket telah dikonsumsi.

Deskripsi operasi

Catatan

API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.

If a message is not consumed as expected, you can call this operation to query the information about the message for troubleshooting.
This operation uses the exact match method to query a message based on the message ID. You can obtain the message ID from the SendResult parameter that is returned after the message is sent. You must store the returned information after each message is sent. The queried information about a message includes the point in time when the message was sent, the broker on which the message is stored, and the attributes of the message such as the message key and tag.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

mq:QueryMessage

get

Topic

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

Topic

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

None

mq:OnsInstanceBaseInfo

Parameter permintaan

Parameter	Type	Required	Description	Example
MsgId	string	Yes	ID Paket yang ingin Anda kueri.	1E0578FE110F18B4AAC235C05F2*****
Topic	string	Yes	Topik yang berisi Paket yang ingin Anda kueri.	test-mq_topic
InstanceId	string	No	ID instans tempat Paket yang ingin Anda kueri berada.	MQ_INST_111111111111_DOxxxxxx

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.	A07E3902-B92E-44A6-B6C5-6AA111111****
Data	object	The data returned.
StoreSize	integer	The size of the message.	407
ReconsumeTimes	integer	The number of retries that were performed to send the message to consumers.	1
StoreTimestamp	integer	The timestamp that indicates when the ApsaraMQ for RocketMQ broker stored the message.	1570761026708
InstanceId	string	The ID of the instance	MQ_INST_111111111111_DOxxxxxx
MsgId	string	The ID of the message.	1E0578FE110F18B4AAC235C0C8460BA2
StoreHost	string	The ApsaraMQ for RocketMQ broker that stores the message.	11.220.*.*:10911
Topic	string	The topic to which the message belongs.	test-mq_topic
PropertyList	object
MessageProperty	array<object>	The attributes of the message.
	object
Value	string	The value of the attribute.	TagA
Name	string	The name of the attribute. Valid values: TRACE_ON: indicates whether a trace of the message exists. KEYS: indicates the key of the message. TAGS: indicates the tag that is attached to the message. INSTANCE_ID: indicates the ID of the instance which contains the message. For information about the terms that are used in Message Queue for Apache RocketMQ, see Terms.	TAGS
BornTimestamp	integer	The timestamp that indicates when the message was produced.	1570761026630
BodyCRC	integer	The cyclic redundancy check (CRC) value of the message body.	914112295
BornHost	string	The producer instance that generated the message.	42.120..:64646

Contoh

Respons sukses

JSONformat

{
  "RequestId": "A07E3902-B92E-44A6-B6C5-6AA111111****",
  "Data": {
    "StoreSize": 407,
    "ReconsumeTimes": 1,
    "StoreTimestamp": 1570761026708,
    "InstanceId": "MQ_INST_111111111111_DOxxxxxx",
    "MsgId": "1E0578FE110F18B4AAC235C0C8460BA2",
    "StoreHost": "11.220.***.***:10911",
    "Topic": "test-mq_topic",
    "PropertyList": {
      "MessageProperty": [
        {
          "Value": "TagA",
          "Name": "TAGS"
        }
      ]
    },
    "BornTimestamp": 1570761026630,
    "BodyCRC": 914112295,
    "BornHost": "42.120.**.**:64646"
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.