ListTopics - ApsaraMQ for RocketMQ

Mengambil daftar topik dalam instance 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

*Topic

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	ID instans yang topiknya ingin Anda tanyakan.	rmq-cn-7e22ody****

Parameter permintaan

Parameter	Type	Required	Description	Example
filter	string	No	Kondisi filter. Jika Anda biarkan parameter ini kosong, semua topik dalam instans akan ditanyakan.	topic_test
pageNumber	integer	No	Nomor halaman yang akan dikembalikan.	1
pageSize	integer	No	Jumlah entri yang dikembalikan per halaman.	3
messageTypes	array	No	Tipe pesan dari topik tersebut.
	string	No	Tipe pesan dari topik yang akan ditanyakan. Jika Anda biarkan parameter ini kosong, topik dengan semua tipe pesan akan ditanyakan. Nilai yang valid: TRANSACTION: transactional message FIFO: ordered message DELAY: scheduled or delayed message NORMAL: normal message LITE: lightweight topic Valid values: TRANSACTION : Transactional message FIFO : Ordered message DELAY : Scheduled and delayed message NORMAL : Normal message	NORMAL

Elemen respons

Element	Type	Description	Example
	object	Result<MyPage>
requestId	string	ID permintaan. ID ini unik untuk setiap permintaan dan dapat digunakan untuk memecahkan masalah.	AF9A8B10-C426-530F-A0DD-96320B39****
success	boolean	Menunjukkan apakah permintaan berhasil.	true
data	object	Data yang dikembalikan.
pageNumber	integer	Nomor halaman yang dikembalikan.	1
pageSize	integer	Jumlah entri yang dikembalikan per halaman.	3
totalCount	integer	Total jumlah entri yang dikembalikan.	1
list	array<object>	Data terpaginasi.
	object
regionId	string	ID wilayah tempat instans berada.	cn-hangzhou
instanceId	string	ID instans.	rmq-cn-7e22ody****
topicName	string	Nama topik.	topic_test
messageType	string	Tipe pesan dari topik tersebut. Valid values: TRANSACTION : Transactional message FIFO : Ordered message DELAY : Scheduled and delayed messages NORMAL : Normal message	NORMAL
status	string	Status topik. Valid values: RUNNING : Running CREATING : Creating	RUNNING
remark	string	Keterangan mengenai topik.	This is the remark for test.
createTime	string	Waktu saat topik dibuat.	2022-08-01 20:05:50
updateTime	string	Waktu terakhir topik dimodifikasi.	2022-08-01 20:05:50
maxSendTps	integer	Jumlah maksimum pesan yang dapat dikirim per detik.	1000
liteTopicExpiration	integer	Waktu kedaluwarsa topik ringan. Satuan: menit.	20
code	string	Kode kesalahan.	Topic.NotFound
message	string	Pesan kesalahan.	The topic cannot be found.
httpStatusCode	integer	Kode status HTTP.	400
dynamicCode	string	Kode kesalahan dinamis.	TopicName
dynamicMessage	string	Pesan kesalahan dinamis.	topicName

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.