Debug konsumsi pesan dengan OnsMessageTrace - ApsaraMQ untuk RocketMQ - Alibaba Cloud - ApsaraMQ for RocketMQ

Deskripsi operasi

Penting

Alibaba Cloud OpenAPI adalah API manajemen yang digunakan untuk mengelola dan mengkueri sumber daya layanan Alibaba Cloud. Integrasikan API ini hanya untuk tujuan manajemen. Jangan gunakan API ini untuk tautan data inti yang mengirim dan menerima pesan. Hal ini dapat menimbulkan ancaman pada tautan data Anda.

Anda dapat menggunakan operasi ini untuk memeriksa status konsumsi suatu pesan guna pemecahan masalah awal ketika terjadi pengecualian konsumsi.
Operasi ini didasarkan pada mekanisme offset internal ApsaraMQ for RocketMQ. Hasilnya dapat diandalkan dalam sebagian besar skenario. Namun, jika Anda mereset offset atau membersihkan pesan, hasilnya mungkin tidak akurat.

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:QueryMessageTrace

get

Topic

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

Topic

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

None

mq:OnsInstanceBaseInfo

Parameter permintaan

Parameter	Type	Required	Description	Example
Topic	string	Yes	Topik pesan.	test-mq_topic
MsgId	string	Yes	ID pesan yang jejaknya ingin Anda kueri. Ini adalah ID pesan.	1E05791C117818B4AAC23B1BB0CE****
InstanceId	string	No	ID instans tempat pesan berada.	MQ_INST_111111111111_DOxxxxxx

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan. Ini adalah parameter umum. Setiap permintaan memiliki ID unik. Gunakan ID ini untuk memecahkan masalah.	EAE5BE23-37A1-4354-94D6-E44AE17E****
Data	object
MessageTrack	array<object>	Hasil kueri.
	object
TrackType	string	The status of the message. Valid values: CONSUMED: The message is consumed. CONSUMED_BUT_FILTERED: No consumer group subscribes to the message. The message is filtered out and not consumed. NOT_CONSUME_YET: The message is not consumed. NOT_ONLINE: The consumer group is offline. UNKNOWN: The message is not consumed due to unknown reasons.	CONSUMED
ConsumerGroup	string	The ID of the consumer group that subscribes to the topic.	GID_test_group_id
InstanceId	string	The ID of the instance to which the message you want to query belongs.	MQ_INST_111111111111_DOxxxxxx

Contoh

Respons sukses

JSONformat

{
  "RequestId": "EAE5BE23-37A1-4354-94D6-E44AE17E****",
  "Data": {
    "MessageTrack": [
      {
        "TrackType": "CONSUMED",
        "ConsumerGroup": "GID_test_group_id",
        "InstanceId": "MQ_INST_111111111111_DOxxxxxx"
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.