Menanyakan pesan dead-letter berdasarkan ID pesan menggunakan OnsDLQMessageGetById - ApsaraMQ untuk RocketMQ - Alibaba Cloud - ApsaraMQ for RocketMQ

Mengkueri Paket dead-letter tertentu berdasarkan ID Paket. Informasi yang dikembalikan mencakup pengatur waktu penyimpanan, body Paket, kunci, dan tag.

Deskripsi operasi

Penting Alibaba Cloud OpenAPI is a management API used to manage and query resources for Alibaba Cloud services. Integrate OpenAPI only for management purposes. Do not use OpenAPI for core data links that send and receive messages, because this can introduce threats to the data links.

Querying a dead-letter message by its message ID is a term query. You can obtain the message ID from the SendResult of a successful send operation or from a batch query API call. The query returns attributes of the dead-letter message, such as its storage time, message body, 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:QueryDLQMessage

get

Group

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

Group

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

None

mq:OnsInstanceBaseInfo

Parameter permintaan

Parameter	Type	Required	Description	Example
MsgId	string	Yes	ID Paket yang akan dikueri. Ini adalah ID Paket.	0BC16699165C03B925DB8A404E2D****
GroupId	string	Yes	ID kelompok konsumen.	GID_test_group_id
InstanceId	string	No	ID instans tempat Paket berada.	MQ_INST_111111111111_DOxxxxxx

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	The ID of the request. This is a common parameter. Each request has a unique ID.	A07E3902-B92E-44A6-B6C5-6AA111111****
Data	object	The query results.
StoreSize	integer	The message size. Unit: KB.	407
ReconsumeTimes	integer	The number of times the message has been retried.	1
StoreTimestamp	integer	The timestamp when the message was stored on the server-side. Unit: milliseconds.	1570761026708
InstanceId	string	The instance ID.	MQ_INST_111111111111_DOxxxxxx
MsgId	string	The message ID.	0BC16699165C03B925DB8A404E2D****
StoreHost	string	The server instance that stores the message.	11.220.*.*:10911
Topic	string	The topic of the message.	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 the message trace 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 that contains the message. For information about the terms that are used in ApsaraMQ for RocketMQ, see Terms.	TAGS
BornTimestamp	integer	The timestamp when the message was generated. Unit: milliseconds.	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": "0BC16699165C03B925DB8A404E2D****",
    "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.