Ringkasan API OnsGroupSubDetail untuk langganan grup konsumen - ApsaraMQ for RocketMQ - Alibaba Cloud - ApsaraMQ for RocketMQ

Mengkueri topik yang dilanggan oleh kelompok. Kueri akan gagal jika instans konsumen untuk ID kelompok yang ditentukan sedang offline.

Deskripsi operasi

Penting

The OpenAPI provided by Alibaba Cloud is a management API used to manage and query resources of Alibaba Cloud services. We recommend that you integrate OpenAPI only in management data links. Do not use OpenAPI in core data links for sending and receiving messages. This may pose risks to the data links.

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

get

Group

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

Group

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

None

mq:OnsInstanceBaseInfo

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID instans tempat kelompok berada.	MQ_INST_111111111111_DOxxxxxx
GroupId	string	Yes	ID kelompok yang ingin Anda kueri.	GID_test_group_id

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	A common parameter. The ID of the request. Each request has a unique ID. You can use this ID to troubleshoot issues.	3364E875-013B-442A-BC3C-C1A84DC6****
Data	object	The returned Data object.
SubscriptionDataList	object
SubscriptionDataList	array<object>	The topics to which consumers in the consumer group subscribe. If all consumers in the specified group are offline, no topics are returned.
	object
SubString	string	The expression based on which consumers in the consumer group subscribe to the topic.	*
Topic	string	The name of the topic to which consumers in the consumer group subscribe.	test-mq_topic
GroupId	string	The ID of the group that you want to query.	GID_test_group_id
MessageModel	string	The consumption pattern. Valid values: CLUSTERING: clustering consumption BROADCASTING: broadcasting consumption For more information about consumption patterns, see Clustering consumption and broadcasting consumption.	CLUSTERING
Online	boolean	Indicates whether the consumer is online.	true

Contoh

Respons sukses

JSONformat

{
  "RequestId": "3364E875-013B-442A-BC3C-C1A84DC6****",
  "Data": {
    "SubscriptionDataList": {
      "SubscriptionDataList": [
        {
          "SubString": "*",
          "Topic": "test-mq_topic"
        }
      ]
    },
    "GroupId": "GID_test_group_id",
    "MessageModel": "CLUSTERING",
    "Online": true
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.