CreateConsumerGroup - ApsaraMQ for RocketMQ

Membuat kelompok konsumen untuk ApsaraMQ for RocketMQ. Kelompok konsumen adalah grup load balancing yang terdiri atas beberapa konsumen dengan perilaku konsumsi yang sama. Konsumen harus menentukan kelompok konsumen dan topik terkait untuk berlangganan pesan.

Deskripsi operasi

Penting Alibaba Cloud OpenAPI adalah API management yang digunakan untuk mengelola dan mengkueri sumber daya layanan Alibaba Cloud. Integrasi API ini hanya ditujukan untuk keperluan manajemen. Jangan gunakan API ini untuk tautan data inti yang mengirim dan menerima pesan karena dapat menimbulkan risiko pada tautan 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

rocketmq:CreateConsumerGroup

create

*ConsumerGroup

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

None

Sintaks permintaan

POST /instances/{instanceId}/consumerGroups/{consumerGroupId} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	ID instans tempat kelompok konsumen tersebut berada.	rmq-cn-7e22ody****
consumerGroupId	string	Yes	ID kelompok konsumen yang ingin Anda buat. ID ini digunakan untuk mengidentifikasi kelompok konsumen dan harus unik secara global. Nilai harus memenuhi persyaratan berikut: ID dapat berisi huruf, angka, garis bawah (_), dan tanda hubung (-). Panjang ID harus antara 1 hingga 60 karakter. Untuk informasi lebih lanjut tentang karakter terlarang, lihat Batasan parameter.	GID_test_groupId

Parameter permintaan

Parameter	Type	Required	Description	Example
body	object	No	Badan permintaan.
remark	string	No	Keterangan untuk kelompok konsumen.	This is the remark for test.
deliveryOrderType	string	Yes	Urutan pengiriman untuk kelompok konsumen. Nilai yang valid: Concurrently: Pesan dikirim secara konkuren. Orderly: Pesan dikirim secara berurutan. Valid values: Concurrently : Concurrent delivery Orderly : Orderly delivery	Concurrently
consumeRetryPolicy	object	Yes	Kebijakan retry untuk kelompok konsumen. Untuk informasi selengkapnya, lihat Message retry.
maxRetryTimes	integer	No	Jumlah maksimum retry.	16
retryPolicy	string	Yes	Jenis kebijakan retry. Untuk informasi selengkapnya, lihat Message retry. Nilai yang valid: FixedRetryPolicy: retry dengan interval tetap. Kebijakan ini hanya tersedia untuk pengiriman pesan berurutan. DefaultRetryPolicy: retry dengan backoff. Kebijakan ini hanya tersedia untuk pengiriman pesan konkuren. Valid values: FixedRetryPolicy : Fixed-interval retry DefaultRetryPolicy : Backoff retry	DefaultRetryPolicy
deadLetterTargetTopic	string	No	Topik dead-letter. Jika konsumen gagal mengonsumsi pesan setelah mencapai jumlah maksimum retry, pesan tersebut akan dikirim ke topik dead-letter. Anda kemudian dapat melakukan pemulihan bisnis atau melacak kembali pesan tersebut. Untuk informasi selengkapnya, lihat Message retry and dead-letter messages.	DLQ_mqtest
fixedIntervalRetryTime	integer	No	Interval retry tetap. Satuan: detik. Parameter ini hanya berlaku jika Anda mengatur kebijakan retry ke FixedRetryPolicy. Nilai yang valid: Concurrent delivery: 10 hingga 1800 Orderly delivery: 1 hingga 600	10
maxReceiveTps	integer	No	TPS maksimum untuk konsumsi pesan.	1000
messageModel	string	No	Mode konsumsi. Nilai yang valid: CLUSTERING LITE_SELECTIVE	LITE_SELECTIVE
topicName	string	No	Nama topik lite yang dilanggani oleh kelompok konsumen. Parameter ini wajib diisi jika Anda mengatur messageModel ke LITE_SELECTIVE.	liteTopicTest

Elemen respons

Element	Type	Description	Example
	object	Result<boolean>
requestId	string	ID permintaan. Setiap permintaan memiliki ID unik. Anda dapat menggunakan ID ini untuk pemecahan masalah dan pelacakan isu.	AF9A8B10-C426-530F-A0DD-96320B39****
success	boolean	Menunjukkan apakah panggilan berhasil.	true
data	boolean	Data yang dikembalikan.	true
code	string	Kode kesalahan.	InvalidConsumerGroupId
message	string	Pesan kesalahan.	Parameter consumerGroupId is invalid.
httpStatusCode	integer	Kode status HTTP.	400
dynamicCode	string	Kode kesalahan dinamis.	ConsumerGroupId
dynamicMessage	string	Pesan kesalahan dinamis.	consumerGroupId

Contoh

Respons sukses

JSONformat

{
  "requestId": "AF9A8B10-C426-530F-A0DD-96320B39****",
  "success": true,
  "data": true,
  "code": "InvalidConsumerGroupId",
  "message": "Parameter consumerGroupId is invalid.",
  "httpStatusCode": 400,
  "dynamicCode": "ConsumerGroupId",
  "dynamicMessage": "consumerGroupId"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.