Kueri topik menggunakan ListTopics - ApsaraMQ for RocketMQ - Alibaba Cloud - ApsaraMQ for RocketMQ

Mengkueri daftar topik dalam instans tertentu.

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

list

*Topik.

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

None

Sintaks permintaan

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

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	Instans yang daftar topiknya ingin Anda kueri.	rmq-cn-7e22ody****

Parameter permintaan

Parameter	Type	Required	Description	Example
filter	string	No	Kondisi filter untuk kueri. Jika tidak ditentukan, semua topik dalam instans akan dikembalikan.	topic_test
pageNumber	integer	No	Nomor halaman hasil yang akan dikembalikan.	1
pageSize	integer	No	Jumlah maksimum hasil yang ditampilkan per halaman.	3
messageTypes	array	No	Tipe Paket topik.
	string	No	Tipe topik yang akan dikueri dalam instans. Jika tidak ditentukan, semua topik dalam instans akan dikembalikan. Nilai valid: TRANSACTION: Pesan transaksional FIFO: pesan terurut DELAY: Paket terjadwal atau tertunda NORMAL: Paket normal LITE: tipe ringan Valid values: TRANSACTION : Pesan transaksional. FIFO : pesan terurut. DELAY : Paket terjadwal atau tertunda. NORMAL : Paket normal.	NORMAL

Elemen respons

Element	Type	Description	Example
	object	Result<MyPage>
requestId	string	ID permintaan. Setiap permintaan memiliki ID unik yang dapat digunakan untuk memecahkan masalah dan melacak isu.	AF9A8B10-C426-530F-A0DD-96320B39****
success	boolean	Menunjukkan apakah operasi berhasil.	true
data	object	Hasil pengembalian.
pageNumber	integer	Nomor halaman saat ini.	1
pageSize	integer	Ukuran halaman.	3
totalCount	integer	Jumlah total hasil yang dikembalikan.	1
list	array<object>	Data halaman.
	object
regionId	string	ID wilayah tempat instans berada.	cn-hangzhou
instanceId	string	ID instans.	rmq-cn-7e22ody****
topicName	string	Nama topik.	Topik_test
messageType	string	Tipe Paket topik. Valid values: TRANSACTION : Pesan transaksional. FIFO : pesan terurut. DELAY : Paket terjadwal atau tertunda. NORMAL : Paket normal.	NORMAL
status	string	Status topik. Valid values: RUNNING : Berjalan. CREATING : Sedang dibuat.	RUNNING
remark	string	Keterangan untuk topik.	Ini adalah keterangan untuk pengujian
createTime	string	pengatur waktu pembuatan dalam format YYYY-MM-DD HH:mm:ss.	2022-08-01 20:05:50
updateTime	string	pengatur waktu modifikasi terakhir topik dalam format YYYY-MM-DD HH:mm:ss.	2022-08-01 20:05:50
maxSendTps	integer	TPS maksimum untuk mengirim Paket.	1000
liteTopicExpiration	integer	pengatur waktu kedaluwarsa topik lite, dalam menit.	20
code	string	Kode kesalahan.	Topic.NotFound
message	string	Paket kesalahan.	Topik tidak dapat ditemukan
httpStatusCode	integer	Kode status HTTP.	400
dynamicCode	string	Kode kesalahan dinamis.	TopicName
dynamicMessage	string	Paket kesalahan dinamis.	TopikName

Contoh

Respons sukses

JSONformat

{
  "requestId": "AF9A8B10-C426-530F-A0DD-96320B39****",
  "success": true,
  "data": {
    "pageNumber": 1,
    "pageSize": 3,
    "totalCount": 1,
    "list": [
      {
        "regionId": "cn-hangzhou",
        "instanceId": "rmq-cn-7e22ody****",
        "topicName": "topic_test",
        "messageType": "NORMAL",
        "status": "RUNNING",
        "remark": "This is the remark for test.",
        "createTime": "2022-08-01 20:05:50",
        "updateTime": "2022-08-01 20:05:50",
        "maxSendTps": 1000,
        "liteTopicExpiration": 20
      }
    ]
  },
  "code": "Topic.NotFound",
  "message": "The topic cannot be found.",
  "httpStatusCode": 400,
  "dynamicCode": "TopicName",
  "dynamicMessage": "topicName"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.