Gunakan OnsMessageGetByKey untuk mengkueri pesan berdasarkan kunci dan topik-ApsaraMQ for RocketMQ-Alibaba Cloud - ApsaraMQ for RocketMQ

Melakukan kueri fuzzy untuk daftar pesan berdasarkan topik dan kunci pesan.

Deskripsi operasi

Penting

OpenAPI yang disediakan oleh Alibaba Cloud adalah API manajemen. Anda dapat menggunakannya untuk mengelola dan mengkueri sumber daya layanan Alibaba Cloud. Kami menyarankan agar Anda hanya mengintegrasikan API ini ke dalam jalur data manajemen. Jangan gunakan API ini untuk jalur data inti yang mengirim dan menerima pesan. Hal ini dapat menimbulkan ancaman keamanan pada jalur data Anda.

Operasi ini melakukan kueri fuzzy untuk pesan berdasarkan kunci pesan. Karena kunci pesan tidak selalu unik, kueri dapat mengembalikan beberapa pesan.
Anda dapat menggunakan operasi ini ketika Anda tidak dapat memperoleh ID pesan. Dalam skenario ini, ikuti langkah-langkah berikut:
1. Panggil operasi ini untuk melakukan kueri fuzzy dan memperoleh daftar ID pesan.
2. Panggil operasi OnsMessageGetByMsgId untuk melakukan kueri istilah. Untuk informasi selengkapnya tentang operasi OnsMessageGetByMsgId, lihat OnsMessageGetByMsgId.

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
Topic	string	Yes	Topik pesan yang akan dikueri.	test-mq_topic
Key	string	Yes	Kunci pesan dari pesan yang akan dikueri.	messageKey1
InstanceId	string	No	ID instance tempat pesan berada.	MQ_INST_111111111111_DOxxxxxx

Elemen respons

Element	Type	Description	Example
	object	Respons.
RequestId	string	Parameter umum. ID permintaan bersifat unik dan dapat digunakan untuk memecahkan masalah dan menemukan permasalahan.	A07E3902-B92E-44A6-B6C5-6AA111111****
Data	object
OnsRestMessageDo	array<object>	Daftar hasil kueri.
	array<object>
StoreSize	integer	The size of the message.	406
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.	1570760999811
InstanceId	string	The ID of the instance	MQ_INST_111111111111_DOxxxxxx
MsgId	string	The ID of the message.	1E0578FE110F18B4AAC235C05F2*****
StoreHost	string	The ApsaraMQ for RocketMQ broker that stores the message.	11.193.*.*: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 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 that indicates when the message was produced.	1570760999721
BodyCRC	integer	The cyclic redundancy check (CRC) value of the message body.	914112295
BornHost	string	The producer client that generated the message.	42.120.*.*:59270

Contoh

Respons sukses

JSONformat

{
  "RequestId": "A07E3902-B92E-44A6-B6C5-6AA111111****",
  "Data": {
    "OnsRestMessageDo": [
      {
        "StoreSize": 406,
        "ReconsumeTimes": 1,
        "StoreTimestamp": 1570760999811,
        "InstanceId": "MQ_INST_111111111111_DOxxxxxx",
        "MsgId": "1E0578FE110F18B4AAC235C05F2*****",
        "StoreHost": "11.193.***.***:10911",
        "Topic": "test-mq_topic",
        "PropertyList": {
          "MessageProperty": [
            {
              "Value": "TagA",
              "Name": "TAGS"
            }
          ]
        },
        "BornTimestamp": 1570760999721,
        "BodyCRC": 914112295,
        "BornHost": "42.120.***.***:59270"
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.