Referensi API OnsGroupList untuk Pengambilan ID Grup - ApsaraMQ for RocketMQ - Alibaba Cloud - ApsaraMQ for RocketMQ

Mengkuerikan semua Group ID dalam instance yang ditentukan.

Deskripsi operasi

Penting

Alibaba Cloud OpenAPI adalah API manajemen yang digunakan untuk mengelola dan mengkuerikan resource layanan Alibaba Cloud. Integrasikan OpenAPI hanya ke dalam link data manajemen. Jangan mengandalkan OpenAPI dalam link data inti untuk mengirim dan menerima pesan karena hal ini dapat menimbulkan ancaman terhadap link data Anda.

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

list

Group

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

None

mq:QueryInstanceBaseInfo

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	No	ID instance tempat Group ID berada.	MQ_INST_111111111111_DOxxxxxx
GroupId	string	No	Tentukan sebuah Group ID untuk melakukan kueri fuzzy. Jika Anda mengosongkan parameter ini, semua Group ID akan dikuerikan. Jika Anda memasukkan GID_ABC, kueri fuzzy dilakukan dengan mencocokkan awalan dan akhiran. Semua Group ID yang berisi GID_ABC akan dikembalikan, seperti GID_test_GID_ABC_123 dan GID_ABC_356.	GID_test_group_id
GroupType	string	No	Protokol yang didukung oleh Group ID yang dikuerikan. Group ID untuk protokol TCP dan protokol HTTP tidak dapat dibagikan. Anda harus membuatnya secara terpisah. Nilai yang valid: tcp: Ini adalah nilai default. Ini menunjukkan bahwa Group ID hanya berlaku untuk mengirim dan menerima pesan melalui protokol TCP. http: Menunjukkan bahwa Group ID hanya berlaku untuk mengirim dan menerima pesan melalui protokol HTTP.	tcp
Tag	array<object>	No	Daftar tag yang dilampirkan ke Group ID. Jumlah elemen dalam daftar tidak boleh melebihi 20.
	object	No
Key	string	Yes	Kunci tag dari Group ID. Tentukan keduanya Key dan Value, atau kosongkan keduanya. Jika keduanya ditentukan, sistem akan memfilter Group ID yang cocok. Jika keduanya dikosongkan, semua Group ID akan dikuerikan. Jika Anda menentukan parameter ini, nilainya tidak boleh berupa string kosong. Nilainya dapat memiliki panjang hingga 128 karakter. Nilai tidak boleh diawali dengan `aliyun` atau `acs:`, dan tidak boleh berisi `http://` atau `https://`.	CartService
Value	string	Yes	Nilai tag dari Group ID. Tentukan keduanya Key dan Value, atau kosongkan keduanya. Jika keduanya ditentukan, sistem akan memfilter Group ID yang cocok. Jika keduanya dikosongkan, semua Group ID akan dikuerikan. Jika Anda menentukan parameter ini, nilainya dapat berupa string kosong. Nilainya dapat memiliki panjang hingga 128 karakter. Nilai tidak boleh diawali dengan `aliyun` atau `acs:`, dan tidak boleh berisi `http://` atau `https://`.	ServiceA

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan. Ini adalah parameter umum. Setiap permintaan memiliki ID unik. Anda dapat menggunakan ID ini untuk memecahkan masalah.	16996623-AC4A-43AF-9248-FD9D2D75****
Data	object
SubscribeInfoDo	array<object>	Kumpulan hubungan langganan yang dikembalikan.
	array<object>
Owner	string	The Alibaba Cloud account ID of the user who created the consumer group.	138015630679****
UpdateTime	integer	The most recent point in time when the consumer group was updated.	1570700979000
IndependentNaming	boolean	Indicates whether the instance uses a namespace. Valid values: true: The instance uses a separate namespace. The name of each resource must be unique in the instance. The names of resources in different instances can be the same. false: The instance does not use a separate namespace. The name of each resource must be globally unique within the instance and across all instances.	true
GroupId	string	The ID of the consumer group.	GID_test_group_id
Remark	string	The description of the consumer group.	test
CreateTime	integer	The point in time when the consumer group was created.	1568896605000
Tags	object
Tag	array<object>	The tags that are attached to the consumer group.
	object
Key	string	The key of the tag that is attached to the consumer group.	CartService
Value	string	The value of the tag that is attached to the consumer group.	ServiceA
InstanceId	string	The ID of the instance	MQ_INST_111111111111_DOxxxxxx
GroupType	string	The protocol over which the queried consumer group publishes and subscribes to messages. All clients in a consumer group communicate with the ApsaraMQ for RocketMQ broker over the same protocol. You must create different consumer groups for TCP clients and HTTP clients. Valid values: tcp: indicates that the consumer group publishes and subscribes to messages over TCP. http: indicates that the consumer group publishes and subscribes to messages over HTTP.	tcp

Contoh

Respons sukses

JSONformat

{
  "RequestId": "16996623-AC4A-43AF-9248-FD9D2D75****",
  "Data": {
    "SubscribeInfoDo": [
      {
        "Owner": "138015630679****",
        "UpdateTime": 1570700979000,
        "IndependentNaming": true,
        "GroupId": "GID_test_group_id",
        "Remark": "test",
        "CreateTime": 1568896605000,
        "Tags": {
          "Tag": [
            {
              "Key": "CartService",
              "Value": "ServiceA"
            }
          ]
        },
        "InstanceId": "MQ_INST_111111111111_DOxxxxxx",
        "GroupType": "tcp"
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.