OnsTopicStatus - ApsaraMQ for RocketMQ - Alibaba Cloud - ApsaraMQ for RocketMQ

Deskripsi operasi

Catatan

Operasi API yang disediakan oleh Alibaba Cloud digunakan untuk mengelola dan mengkueri sumber daya layanan Alibaba Cloud. Kami merekomendasikan agar Anda mengintegrasikan operasi API ini hanya dalam sistem manajemen. Jangan gunakan operasi API ini di sistem inti layanan pesan. Jika tidak, risiko sistem dapat terjadi.

Anda dapat menentukan penggunaan sumber daya suatu topik berdasarkan informasi yang dikembalikan oleh operasi ini. Informasi yang dikembalikan mencakup jumlah total pesan dalam topik dan titik waktu terbaru ketika pesan dipublikasikan ke topik.

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

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	Nama topik yang ingin Anda kueri.	test
InstanceId	string	No	ID instans yang berisi topik yang ingin Anda kueri.	MQ_INST_188077086902****_BXSuW61e

Elemen respons

Element	Type	Description	Example
	object	Pesan yang dikembalikan.
RequestId	string	ID permintaan. Parameter ini adalah parameter umum. Setiap permintaan memiliki ID yang unik. Anda dapat menggunakan ID ini untuk memecahkan masalah.	427EE49D-D762-41FB-8F3D-9BAC96C3****
Data	object	Struktur data dari topik yang dikueri.
Perm	integer	Menunjukkan operasi yang dapat Anda lakukan pada topik. Nilai yang valid: 2: Anda dapat memublikasikan pesan ke topik. 4: Anda dapat berlangganan topik. 6: Anda dapat memublikasikan pesan ke dan berlangganan topik.	6
LastTimeStamp	integer	Titik waktu ketika pesan terbaru siap di topik. Jika tidak ada pesan di topik, nilai pengembalian parameter ini adalah 0. Nilai parameter ini adalah stempel waktu UNIX dalam milidetik. Untuk informasi tentang definisi pesan siap dan waktu siap, lihat Istilah.	1570864984364
TotalCount	integer	Jumlah total pesan di semua partisi topik.	2310

Contoh

Respons sukses

JSONformat

{
  "RequestId": "427EE49D-D762-41FB-8F3D-9BAC96C3****",
  "Data": {
    "Perm": 6,
    "LastTimeStamp": 1570864984364,
    "TotalCount": 2310
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.