Ambil Pesan Topik Melalui API ListMessages - ApsaraMQ for RocketMQ - Alibaba Cloud - ApsaraMQ for RocketMQ

Mengkueri daftar Paket.

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

rocketmq:ListMessages

list

*Topic

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}

None

Sintaks permintaan

GET /instances/{instanceId}/topics/{topicName}/messages HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	ID instans.	rmq-cn-zvp2vtypu05
topicName	string	Yes	Nama topik.	test_delay_queue

Parameter permintaan

Parameter	Type	Required	Description	Example
messageId	string	No	ID Paket.	7F00000100207A4F0F294A938F7807AE
messageKey	string	No	kunci pesan.	XSCBillResult
startTime	string	No	Awal Rentang Waktu untuk dikueri.	2024-09-09 08:00:00
endTime	string	No	Akhir Rentang Waktu untuk dikueri.	2024-09-09 09:00:00
pageNumber	integer	No	Nomor halaman. Halaman dimulai dari 1.	1
pageSize	integer	No	Jumlah entri yang dikembalikan pada setiap halaman.	10
scrollId	string	No	ID scroll. Jangan tentukan parameter ini untuk permintaan pertama. Untuk kueri berhalaman berikutnya, tetapkan parameter ini ke ID scroll yang dikembalikan dalam tanggapan sebelumnya.	B13D0B07-F24B-4790-88D8-D47A38063D00
liteTopicName	string	No	Nama topik ringan.	abc

Elemen respons

Element	Type	Description	Example
	object	The response.
requestId	string	The request ID.	A3531B6A-5A88-52BD-B3C4-A024C3D0AA2E
success	boolean	Indicates whether the request was successful.	true
data	object	The returned data.
pageNumber	integer	The page number of the returned page.	1
pageSize	integer	The number of entries returned per page.	50
totalCount	integer	The total number of records.	0
list	array<object>	The paged data.
	array<object>	The message information.
regionId	string	The region ID.	cn-hangzhou
instanceId	string	The instance ID.	rmq-cn-7e22ody****
topicName	string	The topic name.	topic_test
messageId	string	The message ID.	7F000001000114B4340C5ABF94500079
bornTime	string	The time when the message was created.	2023-03-22 12:17:08
storeTime	string	The time when the message was stored.	2023-03-22 12:17:08
body	string	The message body.	{}
bodySize	integer	The size of the message body.	100
bornHost	string	The client that produced the message.	xx.xx.xx.xx
storeHost	string	The server that stored the message.	xx.xx.xx.xx
messageType	string	The message type.	NORMAL
messageTag	string	The message tag.	xx
messageGroup	string	The message group. This parameter is specific to ordered messages.	xx
messageKeys	array	The business keys.
	string	The business key.	xx
userProperties	object	The user properties.
	string	The user property.	xx
liteTopicName	string	The name of the lightweight topic.	abc
scrollId	string	The scroll ID. The system generates this ID automatically. To retrieve the next page of results, include this ID in the subsequent request.	B13D0B07-F24B-4790-88D8-D47A38063D00
code	string	The error code.	MissingInstanceId
message	string	The error message.	Parameter instanceId is mandatory for this action .
httpStatusCode	integer	The HTTP status code.	200
dynamicCode	string	The dynamic error code.	InstanceId
dynamicMessage	string	The dynamic error message.	instanceId

Contoh

Respons sukses

JSONformat

{
  "requestId": "A3531B6A-5A88-52BD-B3C4-A024C3D0AA2E",
  "success": true,
  "data": {
    "pageNumber": 1,
    "pageSize": 50,
    "totalCount": 0,
    "list": [
      {
        "regionId": "cn-hangzhou",
        "instanceId": "rmq-cn-7e22ody****",
        "topicName": "topic_test",
        "messageId": "7F000001000114B4340C5ABF94500079",
        "bornTime": "2023-03-22 12:17:08",
        "storeTime": "2023-03-22 12:17:08",
        "body": "{}",
        "bodySize": 100,
        "bornHost": "xx.xx.xx.xx",
        "storeHost": "xx.xx.xx.xx",
        "messageType": "NORMAL",
        "messageTag": "xx",
        "messageGroup": "xx",
        "messageKeys": [
          "xx"
        ],
        "userProperties": {
          "key": "xx"
        },
        "liteTopicName": "abc"
      }
    ],
    "scrollId": "B13D0B07-F24B-4790-88D8-D47A38063D00"
  },
  "code": "MissingInstanceId",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.