OnsGroupList - ApsaraMQ for RocketMQ

Mengambil daftar semua Group ID dalam suatu instance tertentu.

Deskripsi operasi

Penting Alibaba Cloud OpenAPI adalah API management yang digunakan untuk mengelola dan mengambil informasi mengenai resource layanan Alibaba Cloud. Integrasi OpenAPI hanya berlaku untuk manajemen data link. Jangan mengandalkan OpenAPI pada data link inti untuk mengirim dan menerima pesan karena hal ini dapat menimbulkan ancaman terhadap data link 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 instans tempat Group ID tersebut berada.	MQ_INST_111111111111_DOxxxxxx
GroupId	string	No	Tentukan Group ID untuk melakukan kueri fuzzy. Jika parameter ini dikosongkan, semua Group ID akan diambil. Jika Anda memasukkan GID_ABC, kueri fuzzy dilakukan dengan mencocokkan awalan dan akhiran. Semua Group ID yang mengandung 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 ditanyakan. Group ID untuk protokol TCP dan HTTP tidak dapat dibagikan. Anda harus membuatnya secara terpisah. Nilai yang valid: tcp: Ini adalah nilai default. 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 pada Group ID. Jumlah elemen dalam daftar tidak boleh melebihi 20.
	object	No
Key	string	Yes	Kunci tag dari Group ID. Tentukan kedua Key dan Value, atau biarkan keduanya kosong. Jika keduanya ditentukan, sistem akan menyaring Group ID yang cocok. Jika keduanya dikosongkan, semua Group ID akan diambil. Jika Anda menentukan parameter ini, nilainya tidak boleh berupa string kosong. Nilai dapat memiliki panjang hingga 128 karakter. Tidak boleh diawali dengan `aliyun` atau `acs:`, serta tidak boleh mengandung `http://` atau `https://`.	CartService
Value	string	Yes	Nilai tag dari Group ID. Tentukan kedua Key dan Value, atau biarkan keduanya kosong. Jika keduanya ditentukan, sistem akan menyaring Group ID yang cocok. Jika keduanya dikosongkan, semua Group ID akan diambil. Jika Anda menentukan parameter ini, nilainya boleh berupa string kosong. Nilai dapat memiliki panjang hingga 128 karakter. Tidak boleh diawali dengan `aliyun` atau `acs:`, serta tidak boleh mengandung `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 pemecahan masalah.	16996623-AC4A-43AF-9248-FD9D2D75****
Data	object
SubscribeInfoDo	array<object>	Kumpulan hubungan subscription yang dikembalikan.
	array<object>
Owner	string	Pemilik informasi publikasi.	138015630679****
UpdateTime	integer	Waktu saat Group ID diperbarui.	1570700979000
IndependentNaming	boolean	Menunjukkan apakah instans memiliki namespace. Nilai yang valid: true: Instans memiliki namespace independen. Nama resource harus unik dalam instans tersebut. Nama resource dapat sama antar instans. false: Instans tidak memiliki namespace independen. Nama resource harus unik secara global, baik dalam maupun antar instans.	true
GroupId	string	Group ID, yaitu ID kelompok konsumen.	GID_test_group_id
Remark	string	Keterangan.	test
CreateTime	integer	Waktu saat Group ID dibuat.	1568896605000
Tags	object
Tag	array<object>	Tag yang dilampirkan pada Group ID.
	object
Key	string	Kunci tag.	CartService
Value	string	Nilai tag.	ServiceA
InstanceId	string	ID instans.	MQ_INST_111111111111_DOxxxxxx
GroupType	string	Protokol yang didukung oleh Group ID yang ditanyakan. Group ID untuk protokol TCP dan HTTP tidak dapat dibagikan. Anda harus membuatnya secara terpisah. Nilai yang valid: tcp: 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

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.