ApsaraMQ for RocketMQ:ListConsumerGroups - ApsaraMQ for RocketMQ - Alibaba Cloud - ApsaraMQ for RocketMQ

Mendaftar kelompok konsumen di instans tertentu.

Deskripsi operasi

Penting

The Alibaba Cloud OpenAPI is a management API. You can use this API to manage and query resources for Alibaba Cloud services. Integrate this API only into your management link. Do not use this API in the core data link for sending and receiving messages. This helps prevent potential threats to your data link.

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

rocketmq:ListConsumerGroups

list

*ConsumerGroup

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/consumergroup/*

None

Sintaks permintaan

GET /instances/{instanceId}/consumerGroups HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	ID instans.	rmq-cn-7e22ody****

Parameter permintaan

Parameter	Type	Required	Description	Example
filter	string	No	Kondisi filter. Jika Anda tidak menentukan parameter ini, semua kelompok konsumen di instans akan dikembalikan.	CID-TEST
pageNumber	integer	No	Nomor halaman hasil yang akan dikembalikan.	1
pageSize	integer	No	Jumlah entri yang akan dikembalikan pada setiap halaman. Nilai valid: 10 hingga 100.	10

Elemen respons

Element	Type	Description	Example
	object	Result<MyPage<ConsumerGroupDto>>
requestId	string	The request ID. Each request has a unique ID. You can use this ID to troubleshoot issues.	5503A460-98ED-5543-92CF-4853DE28****
success	boolean	Indicates whether the request was successful.	true
data	object	The returned data.
pageNumber	integer	The current page number.	1
pageSize	integer	The number of entries returned per page.	10
totalCount	integer	The total number of entries returned.	1
list	array<object>	The data returned on the current page.
	object
regionId	string	The ID of the region where the instance resides.	cn-hangzhou
instanceId	string	The instance ID.	rmq-cn-7e22ody****
consumerGroupId	string	The consumer group ID.	GID-TEST
status	string	The status of the consumer group. Valid values: RUNNING : The consumer group is running. CREATING : The consumer group is being created.	RUNNING
remark	string	The remarks on the consumer group.	This is the remark for test.
createTime	string	The time when the consumer group was created.	2022-08-01 20:05:50
updateTime	string	The time when the consumer group was last updated.	2022-08-01 20:05:50
maxReceiveTps	integer	The maximum transactions per second (TPS) for message consumption.	1000
messageModel	string	The consumption mode.	LITE_SELECTIVE
topicName	string	The name of the topic for a lite consumer group.	test1
code	string	The error code.	MissingInstanceId
message	string	The error message.	Parameter InstanceId is mandatory for this action .
httpStatusCode	integer	The HTTP status code.	400
dynamicCode	string	The dynamic error code.	InstanceId
dynamicMessage	string	The dynamic error message.	instanceId

Contoh

Respons sukses

JSONformat

{
  "requestId": "5503A460-98ED-5543-92CF-4853DE28****",
  "success": true,
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 1,
    "list": [
      {
        "regionId": "cn-hangzhou",
        "instanceId": "rmq-cn-7e22ody****",
        "consumerGroupId": "GID-TEST",
        "status": "RUNNING",
        "remark": "This is the remark for test.",
        "createTime": "2022-08-01 20:05:50",
        "updateTime": "2022-08-01 20:05:50",
        "maxReceiveTps": 1000,
        "messageModel": "LITE_SELECTIVE",
        "topicName": "test1"
      }
    ]
  },
  "code": "MissingInstanceId",
  "message": "Parameter InstanceId is mandatory for this action .",
  "httpStatusCode": 400,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.