Ringkasan API OnsTopicSubDetail - ApsaraMQ untuk 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. Sebaiknya Anda mengintegrasikan operasi API ini hanya di sistem manajemen. Jangan gunakan operasi API ini di sistem inti layanan pesan. Jika tidak, risiko sistem dapat terjadi.

Anda dapat memanggil operasi ini untuk mengkueri grup konsumen online yang berlangganan topik tertentu. Jika semua konsumen dalam suatu grup offline, informasi tentang grup tersebut tidak dikembalikan.

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

get

Topic

acs:mq:{#regionId}:{#accountId}:{#TopicName}

Topic

acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#TopicName}

None

mq:OnsInstanceBaseInfo

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID instans yang berisi topik yang ingin Anda kueri.	MQ_INST_111111111111_DOxxxxxx
Topic	string	Yes	Nama topik yang ingin Anda kueri.	test

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan. Parameter ini adalah parameter umum. Setiap permintaan memiliki ID unik. Anda dapat menggunakan ID ini untuk memecahkan masalah.	87B6207F-2908-42B5-A134-84956DCA****
Data	object	Data yang dikembalikan.
SubscriptionDataList	object
SubscriptionDataList	array<object>	The information about the online consumer groups that subscribe to the topic.
	object
GroupId	string	The ID of the consumer group that subscribes to the topic.	GID_test
MessageModel	string	The consumption mode. Valid values: CLUSTERING: the clustering consumption mode BROADCASTING: the broadcasting consumption mode For more information about consumption modes, see Clustering consumption and broadcasting consumption.	CLUSTERING
SubString	string	The expression based on which consumers in the consumer group subscribe to the topic.	*
Online	string	Indicates whether the consumer group is online.	true
Topic	string	Nama topik.	test

Contoh

Respons sukses

JSONformat

{
  "RequestId": "87B6207F-2908-42B5-A134-84956DCA****",
  "Data": {
    "SubscriptionDataList": {
      "SubscriptionDataList": [
        {
          "GroupId": "GID_test",
          "MessageModel": "CLUSTERING",
          "SubString": "*",
          "Online": "true"
        }
      ]
    },
    "Topic": "test"
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.